CLI Reference

Full reference

This page is a quick-start overview. For the complete, up-to-date CLI reference — including all flags, subcommands, and the config command family — see CLI Reference.

The Archipelago CLI (archipelago_cli) is a Dart command-line tool for generating and managing Flutter monorepo projects.

Installation

dart pub global activate archipelago_cli

Commands

archipelago create

Create a new Archipelago project with interactive configuration.

archipelago create

Opens an interactive JSON config in your editor where you set project name, package name, flavors, features, and more. Once saved, the CLI generates the full monorepo structure.

archipelago doctor

Check system health and validate all required dependencies.

# Basic check
archipelago doctor

# Auto-install missing tools
archipelago doctor --fix

# Check brick-specific dependencies
archipelago doctor --brick auth_sdk

Checks for: Dart SDK, Flutter SDK, Git, FVM, Mason, Melos, Rename, PubViz, FlutterGen, svgo, pngquant, lcov.

archipelago --version

Show current CLI version.

archipelago completion install

Install shell completion for bash/zsh.

Configuration

The CLI uses an ephemeral JSON config flow:

1. Template config is copied to a temp file
2. Your $EDITOR opens for editing
3. CLI reads the config, strips comments, and generates the project
4. Temp file is cleaned up

Authentication

For Pro/Enterprise features, authenticate with your API token:

# Prompts to paste your token (hidden input)
archipelago auth login

# Opens browser to the authorization page, then prompts for the token
archipelago auth login --interactive

# Pass the token directly (for CI)
archipelago auth login --token <your_api_token>

Get your API token from the dashboard. The token is not auto-copied — you paste it at the CLI prompt.

Bundle Cache

Downloaded bricks are cached at ~/.archipelago/bundles/. The CLI checks for updates on each run with a TTL-based cache.

Environment Variables

Variable	Description
ARCHIPELAGO_API_URL	Override API base URL (default: production)
EDITOR	Editor for config files (default: vim)