Metaplay Docs

Appearance

metaplay init ci [flags]

Initialize CI/CD configuration for the project

metaplay init ci [flags] ​

Initialize CI/CD pipeline configuration for deploying game servers to Metaplay cloud.

This command generates CI/CD configuration files for your chosen provider:

  • GitHub Actions: Creates workflow files using Metaplay's reusable workflows
  • Bitbucket Pipelines: Creates pipeline configuration for Bitbucket
  • Generic CI: Creates shell scripts for use with any CI system

The generated files include all necessary steps to build and deploy your game server to the selected environment(s).

Prerequisites:

  • A Metaplay project with metaplay-project.yaml
  • At least one environment configured in the project
  • A machine user created in the Metaplay portal for CI authentication

Examples ​

sh
# Interactive setup - choose CI provider and environment
metaplay init ci
# Initialize GitHub Actions for a specific environment
metaplay init ci --provider=github --environment=nimbly
# Initialize for multiple environments, overwriting existing files
metaplay init ci --provider=github --environment=nimbly,prod --on-conflict=overwrite --yes
# Re-generate files with .new suffix to compare against existing ones
metaplay init ci --provider=github --environment=all --on-conflict=rename --yes

Flags ​

  • --environment <string>: Target environment(s): human ID, comma-separated list, or 'all'
  • --on-conflict <string>: How to handle existing files: overwrite, rename, or skip
  • --output-dir <string>: Output directory for CI files (defaults to project root)
  • --provider <string>: CI provider to use: github, bitbucket, or generic
  • --yes: Automatically confirm file writes

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]