Forgexa CLI — command-line client and AI agent runtime for the Forgexa platform
Project description
Forgexa CLI
Command-line client and agent runtime for the Forgexa platform.
Lightweight — communicates with the Forgexa server via REST API using only Python stdlib. Includes a built-in daemon that discovers local AI agents (Claude Code, Codex, Gemini CLI, OpenCode, Kimi Code, etc.) and executes tasks on behalf of the server.
Installation
# From PyPI (recommended)
pip install forgexa-cli
# Or with pipx (isolated environment)
pipx install forgexa-cli
# Verify installation
forgexa version
Development Installation
# Install from source (editable mode)
git clone https://github.com/forgexa/forgexa.git
cd ai-software-factory/cli
pip install -e .
Quick Start
# Configure server (default: http://localhost:8000)
export FORGEXA_SERVER_URL=https://your-server.example.com
# Login (saves token to ~/.forgexa/token)
forgexa login
# List workspaces
forgexa workspace list
# List projects
forgexa project list --workspace <workspace-id>
# Show kanban board
forgexa board --project <project-id>
Commands
| Command | Description |
|---|---|
forgexa login |
Login and save access token |
forgexa logout |
Remove saved token |
forgexa workspace list |
List workspaces |
forgexa workspace create <name> |
Create a workspace |
forgexa project list --workspace <id> |
List projects |
forgexa project create <name> --workspace <id> |
Create a project |
forgexa requirement list --project <id> |
List requirements |
forgexa requirement create <title> --project <id> |
Create a requirement |
forgexa requirement analyze --id <id> |
Analyze a requirement |
forgexa board --project <id> |
Show kanban board |
forgexa run list --project <id> |
List executions |
forgexa run start <execution-id> |
Start an execution |
forgexa gates pending |
List pending gates |
forgexa gates approve --gate <id> |
Approve a gate |
forgexa gates reject --gate <id> |
Reject a gate |
forgexa workflow show --project <id> |
Show workflow policy |
forgexa workflow reload --project <id> |
Reload workflow |
forgexa budget --workspace <id> |
Budget overview |
forgexa daemon start |
Start local daemon (discover agents, run tasks) |
forgexa daemon start -d |
Start daemon in background |
forgexa daemon status |
Show daemon statuses |
forgexa daemon stop |
Stop local daemon |
forgexa runtimes list |
List runtimes |
forgexa version |
Show CLI version |
Configuration
| Variable | Default | Description |
|---|---|---|
FORGEXA_SERVER_URL |
http://localhost:8000 |
`Server base URL |
FORGEXA_TOKEN |
— | Bearer token (overrides ~/.forgexa/token) |
Output Format
forgexa workspace list # Table (default)
forgexa workspace list --format json # JSON
forgexa workspace list --format quiet # IDs only
Daemon Management
The daemon discovers locally installed AI agents and registers them with the Forgexa server. It then polls for tasks and executes them using your local agents.
Start Daemon
# Foreground (default — see logs, Ctrl+C to stop)
forgexa daemon start
# Background (detached)
forgexa daemon start -d
# Connect to a specific server
forgexa daemon start --server-url https://your-server.example.com
# Or via the standalone entry point
forgexa-daemon
Other Daemon Commands
# Check daemon status (from server)
forgexa daemon status
# Stop background daemon
forgexa daemon stop
Supported AI Agents
The daemon automatically discovers these agents if installed on your system:
| Agent | Command |
|---|---|
| Claude Code | claude |
| OpenAI Codex | codex |
| Gemini CLI | gemini |
| OpenCode | opencode |
| Kimi Code | kimi |
Environment Variables (Daemon)
| Variable | Default | Description |
|---|---|---|
DAEMON_SERVER_URL |
http://localhost:8000 |
Server to connect to |
DAEMON_API_TOKEN |
— | Auth token (auto-read from ~/.forgexa/token) |
DAEMON_MAX_CONCURRENT |
5 |
Max parallel tasks |
DAEMON_POLL_INTERVAL |
3 |
Poll interval (seconds) |
Publishing to PyPI
Prerequisites
pip install build twine
Build & Publish
cd cli/
# Build only (creates dist/)
./scripts/publish.sh build
# Publish to TestPyPI (for testing)
./scripts/publish.sh test
# Publish to PyPI (production)
./scripts/publish.sh
Version Bumping
# Bump version (updates pyproject.toml + __init__.py)
./scripts/bump-version.sh 1.1.0
# Then commit, tag, and publish
git add -A && git commit -m "release(cli): v1.1.0"
git tag cli-v1.1.0
./scripts/publish.sh
PyPI Authentication
Configure via environment variables or ~/.pypirc:
# Using API token (recommended)
export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-AgEIcH...
# Or create ~/.pypirc
cat > ~/.pypirc << 'EOF'
[pypi]
username = __token__
password = pypi-AgEIcH...
[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = pypi-AgEIcH...
EOF
chmod 600 ~/.pypirc
Local Development & Debugging
Editable Install
cd cli
pip install -e .
This installs the forgexa command pointing to your local source. Changes take effect immediately.
Testing Against Local Server
# Point CLI to local backend
export FORGEXA_SERVER_URL=http://localhost:8000
# Login
forgexa login
# Test commands
forgexa workspace list
forgexa daemon start
Testing Against Remote/LAN Server
export FORGEXA_SERVER_URL=http://192.168.0.100:8000
forgexa login
forgexa daemon start
Debugging the Daemon
# Run in foreground to see all logs
forgexa daemon start
# Check which agents are discovered
forgexa runtimes list
# Verbose logging (if supported)
DAEMON_LOG_LEVEL=DEBUG forgexa daemon start
Project Structure
cli/
├── forgexa_cli/
│ ├── __init__.py # Version constant
│ ├── main.py # CLI entry point (argparse)
│ ├── daemon.py # Daemon implementation
│ └── py.typed # PEP 561 marker
├── scripts/
│ ├── bump-version.sh # Version management
│ ├── publish.sh # PyPI publishing
│ └── sync-daemon.sh # Sync daemon code from backend
├── pyproject.toml # Package metadata
└── README.md # This file
Design Principles
- Zero external dependencies — uses only Python stdlib (urllib, json, subprocess)
- Lightweight — installs in seconds, no compilation needed
- Cross-platform — works on Linux, macOS, Windows
- Standalone daemon — discovers local AI agents without server-side configuration
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file forgexa_cli-1.8.10.tar.gz.
File metadata
- Download URL: forgexa_cli-1.8.10.tar.gz
- Upload date:
- Size: 83.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
659d8f87985207aad0fb850a2aee1df73c5adcd34960882c4e38466c1991d36a
|
|
| MD5 |
df43663f34e0d2b03185180c2a769b8e
|
|
| BLAKE2b-256 |
e497aa312b3594c8b0e4922f901e8cc1bd2e01a71bf31802d25145c054aada12
|
File details
Details for the file forgexa_cli-1.8.10-py3-none-any.whl.
File metadata
- Download URL: forgexa_cli-1.8.10-py3-none-any.whl
- Upload date:
- Size: 82.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
505db321b256b227c6f65acccfb43ed486d3cd01400e0adf036df4d5229ac509
|
|
| MD5 |
4ae057b794f5a201357c4a1dc48e2185
|
|
| BLAKE2b-256 |
f96de52412f8a13f86605549c0fcc60ee83d7b5178aa10657ff57ea6de779357
|