@gitlab/duo-cli 8.41.0 → 8.43.0

package/README.md

@@ -1,18 +1,20 @@
-# GitLab CLI Development
+# GitLab Duo CLI
 
-GitLab Duo CLI (`@gitlab/duo-cli`) - GitLab Duo for your command line.
+GitLab Duo for your command line. An AI-powered CLI tool that brings GitLab Duo's capabilities to your terminal.
 
-## Installing
+## Installation
 
-The Duo CLI can be installed from the npm registry using `npm`, `bun`, `yarn` etc:
+Install globally using npm:
 
 ```shell
 npm install -g @gitlab/duo-cli
 ```
 
-After installing, the CLI can be run with `duo`.
+After installation, the CLI can be run using the `duo` command.
 
-Alternatively, the CLI can be directly run without an explicit install:
+### Alternative: Run without installing
+
+You can run the CLI directly without installing it globally:
 
 ```shell
 npx -y @gitlab/duo-cli
@@ -20,71 +22,104 @@ npx -y @gitlab/duo-cli
 
 ### Updating
 
-The CLI can be updated the same way you installed it, specifying `@latest` to ensure the latest version is installed:
+To update to the latest version:
 
 ```shell
 npm install -g @gitlab/duo-cli@latest
 ```
 
-### Usage
+## Usage
 
-Run `duo` to start the CLI terminal UI. You will be prompted for an [authentication token](https://docs.gitlab.com/user/profile/personal_access_tokens/) on first run. Your token must have the `api` scope granted.
+### Interactive Mode (TUI)
 
-The CLI help text can be displayed with the `--help` flag, globally or per-command for more details:
+Start the interactive terminal UI:
 
 ```shell
-duo --help
-duo run --help
+duo
 ```
 
-This will provide details of all available commands and flags.
+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.
 
-## Contributing
+### 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"`
 
-### Prerequisites
+Note that each time you execute `duo run` it will start a fresh workflow, so Duo won't know what the previous conversation or context was.
 
-This CLI project is built using [bun](https://bun.sh/). Make sure you have the following installed:
+Run a workflow in non-interactive mode:
+
+```shell
+duo run --goal "Your goal or prompt here"
+```
 
-1. Install mise and bun: `mise install`
-1. Install dependencies using bun package manager: `npm run install:bun`
+Additional options for headless mode:
 
-in order to continue working with the language server, install dependencies with npm package manager: `npm run install:npm`
+- `--ai-context-items <contextItems>` - JSON encoded array of additional context items
+- `--existing-session-id <sessionId>` - Resume an existing session
 
-### Compilation
+### Configuration
 
-To create standalone executables for distribution, use the compilation script:
+Edit the CLI configuration:
 
 ```shell
-npm run build:binary
+duo config edit
 ```
 
-This will create cross-platform executables in the `./bin` directory:
+### Log Management
 
-- `duo-linux-x64` - Linux 64-bit
-- `duo-linux-arm64` - Linux ARM64
-- `duo-darwin-x64` - macOS Intel
-- `duo-darwin-arm64` - macOS Apple Silicon
-- `duo-windows-x64.exe` - Windows 64-bit
+View and manage logs:
 
-#### Development
+```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
+```
 
-There are a few handy commands available for development:
+### Global Options
 
-- `dev:watch` - starts the application with bun in watch mode. The application will be automatically restarted if code changes are made
-- `dev:watch-tools` - as above, but react devtools will be started alongside connected to the application
-- `start` - compiles the application to js and starts it. This is exactly the version of the app that will be packaged to the npm package. It is recommended to test your changes with it before creating an MR
+### Duo command
 
-When using the `package.json` scripts, use `--` to separate flags between npm/CLI. For example:
+- `-C, --cwd <path>` - Change working directory
+- `--log-level <level>` - Set logging level (debug, info, warn, error)
 
-```shell
-cd packages/cli
-npm run dev:watch -- --cwd /foo/bar # this passes through --cwd to the CLI, rather than npm itself getting the flag
-```
+### 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
 
-### Troubleshooting
+- `-v, --version` - Display version number
+- `--help` - Display help information
 
-If you have issues with Bun not resolving installed node_modules in the packages, you may need to clear node_modules folders and reinstall:
+#### MCP
+
+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
-npm run install:bun
+duo --help              # Global help
+duo run --help          # Help for a specific command
 ```
+
+## Contributing
+
+See [Development Guide](./docs/development.md) for information on contributing to this project.
+
+## License
+
+See the [License](../../LICENSE) for details.