@orca-pt/cli
v1.0.3
Published
CLI tool for managing Orca projects - Quick setup and deployment
Maintainers
Readme
@orca-pt/cli
Command-line interface for Orca project setup, authentication, agent inspection, and shipment workflows.
Installation
Install globally:
npm install -g @orca-pt/cliRun without installing:
npx @orca-pt/cli --helpPrimary command is orca. A fallback alias orcapt is also available.
Requirements
- Node.js 14+
- Docker (for
ship deploy) - Valid workspace token
- Access to an Orca API environment
API Target Configuration
The CLI resolves API target in this order:
ORCA_API_URLORCA_API_<ENV>_URL(whereENVisLOCAL,STAGE, orPROD)ORCA_ENVdefaults (local,stage,prod)
Examples:
# One-off command
ORCA_API_URL="http://localhost:8081" orca login
# Session-wide
export ORCA_API_URL="http://localhost:8081"
orca loginAuthentication
orca login
orca status
orca logoutLogin flow:
- Prompts for workspace and token
- Tries tenant auto-resolution using
tenant = workspace - If tenant resolution fails, prompts for tenant slug as fallback
- Saves credentials locally in
~/.orcapt/config.json
Command Reference
Use orca --help and orca <command> --help for full details.
Core commands
orca loginorca logoutorca statusorca fetch docorca ui init|start|remove
Agent discovery
orca agents ls [--search <text>] [--per-page <number>]orca agent <name|slug|id>
orca agent returns details such as type, endpoint, description, source, docs URL, and runtime flags.
Project setup
orca kickstart python [options]orca kickstart node [options]orca kickstart go
Common kickstart options:
--directory <name>
--port <frontend-port>
--agent-port <backend-port>
--no-startShipment (Lambda and EC2)
ship is the shipment namespace.
Lambda deploy:
orca ship deploy <function-name> --image <registry/image:tag> [options]Options:
--image <image> # required
--memory <mb> # default: 512
--timeout <seconds> # default: 30
--env <key=value> # repeatable
--env-file <path>Lambda management under shipment namespace:
orca ship lambda list
orca ship lambda info <function-name>
orca ship lambda invoke <function-name> [--payload <json>] [--path <path>]
orca ship lambda logs <function-name> [--since <time>] [--page <n>] [--per-page <n>] [--tail]
orca ship lambda remove <function-name>EC2/Hetzner deploy via runner:
orca ship ec2 deploy <app-name> --image <registry/image:tag> [options]
orca ship ec2 stop <deployment-id>
orca ship ec2 status <deployment-id>
orca ship ec2 logs <deployment-id> [--page <n>] [--per-page <n>]EC2 deploy options:
--image <image> # required
--internal-port <port> # required internal app port
--push # tag/push local image to Docker Hub first
--tag <tag> # custom tag when using --push
--container-name <name>
--env <key=value> # repeatable
--env-file <path>
--command <command>Example: Deploy from a Dockerfile (Lambda)
From your project directory:
docker build -t my-agent:latest .
orca ship deploy my-agent-fn --image my-agent:latestExample: Deploy to EC2 runner
docker build -t my-agent:latest .
orca ship ec2 deploy my-agent --image my-agent:latest --internal-port 3000
orca ship ec2 status <deployment-id>
orca ship ec2 logs <deployment-id>Notes
- Some legacy command groups are intentionally hidden from top-level help but may remain callable for compatibility.
- CLI route integrations are organized under
/api/v1/cli/*in Orca API.
Troubleshooting
- Verify API target:
echo $ORCA_API_URL- Verify authentication:
orca status- Ensure Docker is running before shipment:
docker ps