@multiplayer-app/cli 2.0.0 → 2.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Multiplayer Software, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,77 +1,104 @@
 # @multiplayer-app/debugging-agent
 
-Multiplayer CLI — AI-powered debugging agent and release management tool.
+AI-powered debugging agent and release management CLI for [Multiplayer](https://multiplayer.app).
 
 ## Install
 
-```
+```sh
 npm install -g @multiplayer-app/debugging-agent
 ```
 
-## Usage
+## Commands
 
-```
-multiplayer [command] [options]
-```
-
-If no command is provided, the debugging agent starts in TUI mode.
+| Command | Description |
+|---------|-------------|
+| `multiplayer` | Start the debugging agent (TUI by default) |
+| `multiplayer releases create` | Register a release |
+| `multiplayer deployments create` | Register a deployment |
+| `multiplayer sourcemaps upload` | Upload sourcemap files |
 
 ---
 
 ## Debugging Agent
 
-Automatically resolves issues using AI. Connects to the Multiplayer backend and processes incoming issues in real time.
+Connects to the Multiplayer backend and automatically resolves incoming issues using AI.
 
-```
+```sh
 multiplayer [options]
 ```
 
-Options can be provided as flags, environment variables, or a `.multiplayer/config` profile file.
+Options are resolved in this order: **CLI flag → environment variable → config profile**.
 
 | Flag | Env var | Description |
 |------|---------|-------------|
 | `--api-key <key>` | `MULTIPLAYER_API_KEY` | Multiplayer API key |
 | `--dir <path>` | `MULTIPLAYER_DIR` | Project directory (must be a git repo) |
 | `--model <name>` | `AI_MODEL` | AI model (e.g. `claude-sonnet-4-6`, `gpt-4o`) |
-| `--model-key <key>` | `AI_API_KEY` | API key for the AI provider (not needed for Claude) |
-| `--model-url <url>` | `AI_BASE_URL` | Optional base URL for OpenAI-compatible APIs |
-| `--headless` | `MULTIPLAYER_HEADLESS=true` | Run without TUI, outputs structured JSON logs |
-| `--profile <name>` | `MULTIPLAYER_PROFILE` | Config profile to use (default: `default`) |
+| `--model-key <key>` | `AI_API_KEY` | AI provider API key (not required for Claude models) |
+| `--model-url <url>` | `AI_BASE_URL` | Base URL for OpenAI-compatible APIs |
+| `--headless` | `MULTIPLAYER_HEADLESS=true` | Run without TUI — outputs structured JSON logs |
+| `--profile <name>` | `MULTIPLAYER_PROFILE` | Config profile to load (default: `default`) |
 | `--name <name>` | `MULTIPLAYER_AGENT_NAME` | Agent name (defaults to hostname) |
-| `--max-concurrent <n>` | `MULTIPLAYER_MAX_CONCURRENT` | Max parallel issues (default: `2`) |
+| `--max-concurrent <n>` | `MULTIPLAYER_MAX_CONCURRENT` | Max issues resolved in parallel (default: `2`) |
 | `--no-git-branch` | `MULTIPLAYER_NO_GIT_BRANCH=true` | Work in current branch — no worktree, no push |
-| `--health-port <port>` | `MULTIPLAYER_HEALTH_PORT` | HTTP health check port (headless only) |
+| `--health-port <port>` | `MULTIPLAYER_HEALTH_PORT` | HTTP health check port (headless mode only) |
 | `--url <url>` | `MULTIPLAYER_URL` | Multiplayer API base URL |
 
 ### TUI mode (default)
 
-```
+An interactive terminal dashboard that shows active sessions and live logs.
+
+```sh
 multiplayer --api-key <key> --dir /path/to/repo --model claude-sonnet-4-6
 ```
 
 ### Headless mode
 
-```
+Outputs newline-delimited JSON logs — suitable for CI, containers, and log aggregators.
+
+```sh
 multiplayer --headless --api-key <key> --dir /path/to/repo --model claude-sonnet-4-6
 ```
 
+In headless mode, `SIGTERM` waits for active sessions to finish before exiting; `SIGINT` exits immediately.
+
 ### Config profiles
 
-Create a `.multiplayer/config` file in your project or home directory:
+Create a `.multiplayer/config` file in your project directory or home directory (`~/.multiplayer/config`). Uses INI format — the same as AWS credentials.
 
 ```ini
 [default]
-api_key = <your-api-key>
-dir = /path/to/repo
-model = claude-sonnet-4-6
+api_key    = <your-api-key>
+dir        = /path/to/repo
+model      = claude-sonnet-4-6
 max_concurrent = 2
+
+[staging]
+api_key    = <staging-api-key>
+dir        = /path/to/staging-repo
+model      = gpt-4o
+model_key  = <openai-api-key>
 ```
 
+All supported profile keys:
+
+| Key | Description |
+|-----|-------------|
+| `api_key` | Multiplayer API key |
+| `dir` | Project directory |
+| `model` | AI model name |
+| `model_key` | AI provider API key |
+| `model_url` | Base URL for OpenAI-compatible APIs |
+| `name` | Agent name |
+| `url` | Multiplayer API base URL |
+| `max_concurrent` | Max parallel issues |
+| `no_git_branch` | `true` to skip branch/worktree creation |
+
 ---
 
 ## Releases
 
-```
+```sh
 multiplayer releases create [options]
 ```
 
@@ -87,7 +114,7 @@ multiplayer releases create [options]
 
 **Example:**
 
-```
+```sh
 multiplayer releases create \
   --api-key $MULTIPLAYER_API_KEY \
   --service my-service \
@@ -100,7 +127,7 @@ multiplayer releases create \
 
 ## Deployments
 
-```
+```sh
 multiplayer deployments create [options]
 ```
 
@@ -108,13 +135,13 @@ multiplayer deployments create [options]
 |------|---------|-------------|
 | `--api-key <key>` | `MULTIPLAYER_API_KEY` | Multiplayer API key |
 | `--service <name>` | `SERVICE_NAME` | Service name |
-| `--release <version>` | `RELEASE` | Release version |
+| `--release <version>` | `VERSION` | Release version |
 | `--environment <name>` | `ENVIRONMENT` | Environment name |
 | `--base-url <url>` | `BASE_URL` | API base URL (optional) |
 
 **Example:**
 
-```
+```sh
 multiplayer deployments create \
   --api-key $MULTIPLAYER_API_KEY \
   --service my-service \
@@ -126,7 +153,7 @@ multiplayer deployments create \
 
 ## Sourcemaps
 
-```
+```sh
 multiplayer sourcemaps upload <directories...> [options]
 ```
 
@@ -139,7 +166,7 @@ multiplayer sourcemaps upload <directories...> [options]
 
 **Example:**
 
-```
+```sh
 multiplayer sourcemaps upload ./dist ./build \
   --api-key $MULTIPLAYER_API_KEY \
   --service my-service \