@gitlab/duo-cli 8.62.1 → 8.63.0

package/README.md

@@ -1,122 +1,60 @@
 # GitLab Duo CLI (experimental)
 
-GitLab Duo for your command line. An AI-powered CLI tool that brings GitLab Duo's capabilities to your terminal.
+GitLab Duo for your command line. An AI-powered CLI tool that brings
+[GitLab Duo Chat (Agentic)](https://docs.gitlab.com/user/gitlab_duo_chat/agentic_chat/) to your
+terminal.
 
-This tool is [experimental](https://docs.gitlab.com/policy/development_stages_support/#experiment) and some features might not work as expected.
+The GitLab Duo CLI can help you:
 
-## Installation
-
-Install globally using npm:
-
-```shell
-npm install -g @gitlab/duo-cli
-```
+- Understand your codebase structure, cross-file functionality, and individual code snippets.
+- Build, modify, refactor, and modernize code.
+- Troubleshoot errors and fix code issues.
+- Automate CI/CD configuration, troubleshoot pipeline errors, and optimize pipelines.
+- Perform multi-step development tasks autonomously.
 
-After installation, the CLI can be run using the `duo` command.
+This tool is [experimental](https://docs.gitlab.com/policy/development_stages_support/#experiment)
+and some features might not work as expected.
 
-### Alternative: Run without installing
-
-You can run the CLI directly without installing it globally:
+## Installation
 
-```shell
-npx -y @gitlab/duo-cli
-```
+Prerequisites:
 
-### Updating
+- Node.js 22 or later.
+- A [personal access token](https://docs.gitlab.com/user/profile/personal_access_tokens/) with `api`
+  scope.
 
-To update to the latest version:
+To install the GitLab Duo CLI globally, run:
 
 ```shell
-npm install -g @gitlab/duo-cli@latest
+npm install -g @gitlab/duo-cli
 ```
 
-## Usage
-
-### Interactive Mode (TUI)
-
-Start the interactive terminal UI:
+After installation, start the GitLab Duo CLI in interactive mode:
 
 ```shell
 duo
 ```
 
-On first run, you'll be prompted for a [GitLab authentication token](https://docs.gitlab.com/user/profile/personal_access_tokens/). Your token must have the `api` scope granted.
-
-### Headless Mode
-
-The run command is ideal for non-interactive CI environments or integration with scripts and automated workflows. For example, you can run an eslint command and pipe any errors to Duo: `duo run --goal "Fix these errors: $eslint_output"`
-
-Note that each time you execute `duo run` it will start a fresh workflow, so GitLab Duo won't know what the previous conversation or context was.
-
-Run a workflow in non-interactive mode:
+Alternatively, you can run the GitLab Duo CLI without installing:
 
 ```shell
-duo run --goal "Your goal or prompt here"
-```
-
-Additional options for headless mode:
-
-- `--ai-context-items <contextItems>` - JSON encoded array of additional context items
-- `--existing-session-id <sessionId>` - Resume an existing session
-
-### Configuration
-
-Edit the CLI configuration:
-
-```shell
-duo config edit
+npx -y @gitlab/duo-cli
 ```
 
-### Log Management
+To run a workflow in headless mode, use the command `duo run`:
 
-View and manage logs:
+> [!warning]
+> Headless mode bypasses manual tool approval. Use this mode with caution and in a controlled
+> sandbox environment.
 
 ```shell
-duo log last              # Open the last log file
-duo log list              # List all log files
-duo log tail [args...]    # Tail the last log file (supports standard tail arguments)
-duo log clear             # Remove all existing log files
+duo run --goal "Your goal or prompt here"
 ```
 
-### Global Options
-
-### `duo` command
-
-- `-C, --cwd <path>` - Change working directory
-- `--log-level <level>` - Set logging level (debug, info, warn, error)
-
-### `duo run` command
-
-- `--gitlab-base-url <url>` - Base URL of GitLab instance (default: `https://gitlab.com`)
-- `--gitlab-auth-token <token>` - Authentication token for GitLab instance
-
-### Other options
+## Documentation
 
-- `-v, --version` - Display version number
-- `--help` - Display help information
-
-#### MCP
-
-The GitLab Duo CLI supports connecting to local or remote MCP servers using the same MCP configuration as the GitLab IDE extensions. Configuration instructions can be found at [MCP Documentation](https://docs.gitlab.com/user/gitlab_duo/model_context_protocol/mcp_clients/#configure-mcp-servers)
-
-### Environment Variables
-
-You can also configure the CLI using environment variables:
-
-- `GITLAB_URL` or `GITLAB_BASE_URL` - GitLab instance URL
-- `GITLAB_TOKEN` or `GITLAB_OAUTH_TOKEN` - Authentication token
-- `LOG_LEVEL` - Logging level
-- `DUO_WORKFLOW_GIT_HTTP_USER` - Git HTTP authentication username
-- `DUO_WORKFLOW_GIT_HTTP_PASSWORD` - Git HTTP authentication password
-
-### Getting Help
-
-Display help for any command:
-
-```shell
-duo --help              # Global help
-duo run --help          # Help for a specific command
-```
+For detailed setup, usage, troubleshooting, and configuration instructions, see the
+[GitLab Duo CLI documentation](https://docs.gitlab.com/user/gitlab_duo_cli/).
 
 ## Contributing