Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

assistant-cli

Standalone desktop CLI for the Espacebot Orchestrator assistant runtime — run an assistant on your local machine, with your own tools (Claude Code CLI, Ollama, MCP servers), and connect it to your orchestrator over WebSocket.

assistant-cli is a single self-contained binary. No Node.js, no Docker, no runtime to install — just download, point it at your orchestrator, and run.

Installation

Linux / macOS

curl -fsSL https://raw.githubusercontent.com/codeffekt/assistant-cli/main/install.sh | sh

The installer detects your OS and architecture, verifies the SHA-256 checksum of the downloaded archive, and places assistant-cli in $HOME/.local/bin (override with ASSISTANT_CLI_INSTALL_DIR). If $HOME/.local/bin is not on your PATH, the installer prints the line to add to your shell profile.

Windows

iwr -useb https://raw.githubusercontent.com/codeffekt/assistant-cli/main/install.ps1 | iex

The PowerShell script installs assistant-cli.exe into %LOCALAPPDATA%\assistant-cli\bin and adds that directory to your user PATH.

Manual download

Pick the archive matching your platform from the latest release:

OS Architecture Asset
Linux x86_64 assistant-cli-linux-x64.tar.gz
Linux arm64 / aarch64 assistant-cli-linux-arm64.tar.gz
macOS Intel assistant-cli-darwin-x64.tar.gz
macOS Apple Silicon assistant-cli-darwin-arm64.tar.gz
Windows x64 assistant-cli-windows-x64.zip

Extract, place the assistant-cli binary somewhere on your PATH, and run.

macOS Gatekeeper note — binaries are not (yet) signed. When downloaded via curl, no quarantine flag is set and the binary runs normally. If you downloaded the archive through a browser, run xattr -d com.apple.quarantine ./assistant-cli once before the first launch.

Windows SmartScreen note — unsigned binaries trigger a SmartScreen warning. Click "More info → Run anyway" the first time.

Quick start

# 1. In your workspace directory, scaffold a config file:
assistant-cli init
# This creates .espacebot/settings.json with placeholders.

# 2. Edit .espacebot/settings.json and fill in:
#    - orchestratorUrl  (e.g. https://orchestrator.example.com)
#    - assistantId      (UUID from the manager UI)
#    - apiKey           (esbk_... from the manager UI)

# 3. Sync your assistant config from the orchestrator:
assistant-cli sync

# 4. Open an interactive REPL:
assistant-cli chat

# Or fire a one-shot prompt:
assistant-cli run "summarise the README"

assistant-cli --help lists every command.

Provider notes

  • claude-code — if your assistant uses the claude-code provider, the CLI will spawn the claude binary at runtime. assistant-cli does not check for it at install time. If claude is missing or not authenticated when you run a prompt, you will get a clear runtime error.
  • ollama — requires a local Ollama server (default http://localhost:11434).
  • MCP servers (stdio) — declared MCP servers are spawned via stdio when the assistant runs. The CLI does not pre-validate that the MCP commands resolve — failures surface as tool-call errors at runtime.

Verifying downloads

Every release ships a SHA256SUMS file alongside the archives:

curl -LO https://github.com/codeffekt/assistant-cli/releases/latest/download/assistant-cli-linux-x64.tar.gz
curl -LO https://github.com/codeffekt/assistant-cli/releases/latest/download/SHA256SUMS
sha256sum --ignore-missing -c SHA256SUMS
# assistant-cli-linux-x64.tar.gz: OK

Binaries are not code-signed for macOS or Windows in the current release. Code signing is on the roadmap.

Documentation

The full command reference (config resolution, exit codes, every subcommand with its flags and examples) lives in the source repository:

  • Source repository: hosted on GitLab CE (request access from your platform administrator).
  • Public reference: this README covers installation only. For command details, use assistant-cli --help, assistant-cli <command> --help, or contact your operator.

Support

For issues with the CLI itself: open a GitHub issue at codeffekt/assistant-cli.

For platform questions (assistants, orchestrator config, billing): contact your Espacebot Orchestrator administrator.

License

ISC — see LICENSE.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages