Documentation

CLI Guide

Use the Orgs CLI for repeatable local workflows, CI jobs, and operator handoffs.

Configuration

The CLI should be configured with the production API URL and a bearer credential. Store secrets outside shell history when possible.

  • Use separate credentials for local development, CI, and production agents.
  • Do not commit .env files containing Orgs credentials.
export ORGS_API_URL=https://api.orgs.sh
export ORGS_API_KEY=sk_live_...

Entity workflow

The entity workflow mirrors the API: create from a constitution, list entities, inspect detail, start formation, and retrieve status.

orgs entity create --constitution ./constitution.yaml
orgs entity list
orgs entity get <entity-id>
orgs entity formation start <entity-id>
orgs entity formation status <entity-id>

Proposal workflow

Operators and agents can use proposal commands to keep treasury, hiring, amendment, and dissolution actions reviewable.

orgs proposal create --entity <entity-id> --kind spend
orgs proposal list --entity <entity-id>
orgs proposal get <proposal-id>
orgs proposal vote <proposal-id> approve
orgs proposal execute <proposal-id>

Treasury workflow

Treasury commands should be treated as policy-bound operations. If a disbursement requires a proposal, create and approve the proposal before execution.

orgs treasury balance <entity-id>
orgs treasury history <entity-id>
orgs treasury disburse --proposal <proposal-id>
orgs treasury export <entity-id>
Documentation - Orgs