Skip to content

Install & Run

Terminal window
npm install -g @roscoesh/cli
roscoe

That is the shortest useful path. Install once, open the TUI, and start from the dispatch board.

Roscoe home screen after launch
After launch, Roscoe opens on the home screen. Dispatch is the first stop, but the same screen also holds provider setup, Roscoe-wide settings, and channel routing.

New repo

Choose Onboard Project and let Roscoe build the project contract before you launch any implementation lanes.

Existing repo

Choose Start Sessions, review the saved brief, then launch the main repo or a task worktree.

Shell discovery

Use roscoe —help when you need the explicit command surface for scripting or direct lane entry.

  1. Install the CLI globally.
  2. Run roscoe.
  3. If the repo has never been onboarded, choose Onboard Project.
  4. If the repo is already onboarded, choose Start Sessions.
  5. Stay in the TUI unless you specifically need direct CLI commands.
CommandUse
roscoeOpen the home TUI.
roscoe --helpList supported subcommands and flags.
roscoe onboard /path/to/projectRun onboarding directly from the shell.
roscoe profilesCheck which provider and auth profiles Roscoe can see.