Terminal CLI Installation

Orbicus CLI (@orbicus/cli) is a global command-line executable that brings autonomous coding agents directly into your terminal. It supports interactive TUI sessions and headless single-prompt commands for shell scripts and CI/CD pipelines.

Prerequisites

Before installing the CLI, ensure you have Node.js installed:

• Node.js: Version 18.0 or later (node --version)
• Package Manager: npm, pnpm, or yarn

Standalone Installation (Recommended)

Install the standalone binary directly via shell without requiring Node.js:

macOS & Linux

curl -fsSL https://raw.githubusercontent.com/Jafar-Sabaouni/orbicus-releases/main/install.sh | bash

Windows (PowerShell)

irm https://raw.githubusercontent.com/Jafar-Sabaouni/orbicus-releases/main/install.ps1 | iex

Alternative: Global NPM Installation

If you already have Node.js 18+ installed:

npm install -g @orbicus/cli

Verifying Installation

Verify that the CLI executable is available in your PATH:

orbicus --version

To view all available commands and flags:

orbicus --help

Starting an Interactive Session

Navigate to any local codebase or repository and launch Orbicus:

cd ~/projects/my-app
orbicus

Orbicus will automatically detect your project structure, inspect your workspace root, and start the interactive terminal interface.

Headless / Non-Interactive Execution

You can also run Orbicus headlessly with a direct prompt for automated scripts:

orbicus --prompt "Run tests and fix any failing assertions in src/auth.ts"

Next Steps

Configure your API keys or connect to local Ollama endpoints in the Model Provider Setup guide.