Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

orcctl

Administration CLI for the Espacebot Orchestrator platform — manage assistants, sessions, assets and live event streams from your terminal.

orcctl is a single self-contained binary. No Node.js, no Docker, no runtime to install — just download, run, and authenticate against your orchestrator.

Installation

Linux / macOS

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

The installer detects your OS and architecture, verifies the SHA-256 checksum of the downloaded archive, and places orcctl in /usr/local/bin (override with ORCCTL_INSTALL_DIR).

Windows

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

The PowerShell script installs orcctl.exe into %LOCALAPPDATA%\orcctl\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 orcctl-linux-x64.tar.gz
Linux arm64 / aarch64 orcctl-linux-arm64.tar.gz
macOS Intel orcctl-darwin-x64.tar.gz
macOS Apple Silicon orcctl-darwin-arm64.tar.gz
Windows x64 orcctl-windows-x64.zip

Extract, place the orcctl 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 ./orcctl 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. Generate a personal API key in your orchestrator manager UI
#    (Settings → API Keys → Create), then:
orcctl login --url https://orchestrator.example.com --api-key esbk_xxxxxxxx_xxxxx

# 2. Validate the connection.
orcctl ping

# 3. List assistants.
orcctl assistants list

# 4. Stream live events from one assistant.
orcctl monitor watch --assistant asst-xxx

Verifying downloads

Every release ships a SHA256SUMS file alongside the archives:

curl -LO https://github.com/codeffekt/orcctl/releases/latest/download/orcctl-linux-x64.tar.gz
curl -LO https://github.com/codeffekt/orcctl/releases/latest/download/SHA256SUMS
sha256sum --ignore-missing -c SHA256SUMS
# orcctl-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 orcctl --help, orcctl <command> --help, or contact your operator.

Support

For issues with the CLI itself: open a GitHub issue at codeffekt/orcctl.

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

License

ISC — see LICENSE.

About

Administration CLI for the Espacebot Orchestrator platform.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages