MultiConnect.CLI 2.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global MultiConnect.CLI --version 2.2.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local MultiConnect.CLI --version 2.2.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=MultiConnect.CLI&version=2.2.0
                    
nuke :add-package MultiConnect.CLI --version 2.2.0
                    

MultiConnect CLI 2.2

Deploy servers, APIs and websites from a terminal or a CI pipeline, and check on any deployment, databases included.

dotnet tool install --global MultiConnect.CLI   # requires the .NET 8 SDK or later
multiconnect init                                # once per project folder
multiconnect deploy                              # every release after that

Before you start: a deploy key

The CLI signs in with an access key that has "Allow deploys (CLI)" turned on. It can only reach the deployments the key is attached to. Create the key in the dashboard, then attach it from each deployment's Access keys tab. A key can be attached to several deployments. Each project folder is linked to exactly one of them.

A deploy key can upload builds, redeploy, and read status, connection details, usage and the account balance. It cannot create, delete or stop deployments, and it cannot change plans. Those stay in the dashboard. It can never be a client-distributable key.

Commands

Command What it does
multiconnect init Choose which of the key's deployments this folder is for, and how to build it. Writes multiconnect.json.
multiconnect deploy Run the build command, package the build (a folder is zipped; a .zip is used as-is), upload it and roll it out with the deployment's existing settings. Waits until it is live.
multiconnect deploy --config Same, but first lets you change settings interactively: environment variables, start command, container counts, autoscaling, website options and the local build settings. The new settings and the new build go live in the same rollout.
multiconnect status State, build version, any rollout in progress, and the containers.
multiconnect info Connection details.
multiconnect balance Credits, what the account spends per hour, and how long the balance lasts.
multiconnect analytics Cost per hour, usage against the plan, and CPU / RAM / storage per container.
multiconnect versions Servers: the builds running — the latest, any kept for older game clients, any draining — with containers, credits per hour and how long each runs.
multiconnect versions retire <buildNumber> Servers: retire a kept build. Its containers drain and are removed after the grace period. Asks first; --yes skips the question.
multiconnect versions promote <buildNumber> Servers: make a kept build the latest again, deployed as a new build number. The current latest drains after the grace period; --keep-days 7 or --keep-until-retired keeps it for clients built for it. Asks first; --yes skips the question.
multiconnect logs The latest output of one container. --container, --lines, --filter <text>; --follow (-f) keeps printing new lines until Ctrl+C.
multiconnect products pull An SDK app's in-app products (Store Products), written to store-products.json (or --file). Name the app with --sdk-key or MC_SDK_KEY.
multiconnect products push Writes the file into the product list. --remove-missing removes products the file leaves out. Nothing reaches a store yet.
multiconnect products plan What a sync would change in Google Play and the App Store. Exits with 2 when a product changed in more than one place.
multiconnect products sync Applies the plan and waits for the result. Asks before creating or deactivating a store product; --yes in CI.

In deploy --config, each prompt shows the current value: press Enter to keep it, or type - to clear it.

deploy options: --tag, --skip-build, --no-rollback, --no-wait, --timeout <minutes>, --yes, --keep-previous <days|until-retired>.

Keeping a server build for older game clients

multiconnect deploy --keep-previous 30 keeps the build being replaced running for 30 days (1–90), and --keep-previous until-retired keeps it until you retire it. Game clients built for the kept build keep connecting to it; new clients go to the new build. After a server deploy the CLI prints the new build's number. Game clients built for that build connect with that number.

A kept build keeps its containers, and they are billed while they run. multiconnect versions lists what is running, and multiconnect versions retire 1.0.0.8 retires a kept build.

Rollouts are zero-downtime. The current build keeps serving until every new container is healthy, and it is restored automatically if they never become healthy. On a server with a grace period, the old containers keep running for that period so connected players are not dropped. The CLI reports success as soon as the new build is live. The grace period does not hold up your pipeline.

A database has no build, so deploy does not apply to it. status, info, balance and analytics all work.

Master-worker servers take two builds, master and worker, which always deploy together. init asks for both.

multiconnect.json

It records the linked deployment and the build settings, and it is safe to commit. The key is stored in it encrypted for the machine and user that ran init, so a committed copy is useless anywhere else. The deployment's settings are not stored here. They live on the platform, so the dashboard and the CLI never disagree.

CI/CD

Commit multiconnect.json, store the key as pipeline secrets, and run deploy. With the environment variables set, the stored key is not used. Nothing prompts in CI (CI is set, or input is not a terminal). The exit code is non-zero if the build, the upload or the rollout fails.

# GitHub Actions
- uses: actions/setup-dotnet@v4
  with: { dotnet-version: '8.0.x' }
- run: dotnet tool install --global MultiConnect.CLI
- run: multiconnect deploy --tag ${{ github.sha }}
  env:
    MC_ACCESS_KEY: ${{ secrets.MC_ACCESS_KEY }}
    MC_ACCESS_SECRET: ${{ secrets.MC_ACCESS_SECRET }}

Exit codes: 0 live, 1 failed or refused, 2 still rolling out when --timeout ran out.

How requests are signed

Every call is a POST to /api/PublicNew/Cli/<Action> with these headers:

  • X-MC-Key
  • X-MC-Timestamp (ISO 8601 UTC, within five minutes)
  • X-MC-Nonce (new for every request)
  • X-MC-Signature = hex(HMAC-SHA256(secret, "key:timestamp:nonce:path:sha256hex(body)"))

The body is part of the signature, so a captured request cannot be altered to deploy a different build. The nonce stops it from being replayed.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
2.3.0 53 11/19/2026
2.2.0 100 11/15/2026
2.1.0 98 11/13/2026
2.0.2 110 10/14/2026
2.0.1 91 10/14/2026
2.0.0 93 10/14/2026
1.0.1 187 4/14/2026 1.0.1 is deprecated because it is no longer maintained and has critical bugs.
1.0.0 138 4/14/2026 1.0.0 is deprecated because it is no longer maintained and has critical bugs.