Referência da CLI
gotactl accounts
List and inspect accounts
gotactl accounts get
Get an account by ID
Exemplos
gotactl accounts get acc_123 --jsongotactl accounts list
List accounts
Flags
--all | bool | Fetch all pages |
--customer-id | string | Filter by customer ID |
--limit | int | Maximum items to return |
--status | string | Filter by status |
Exemplos
gotactl accounts list --limit 25 --jsongotactl api
Send a raw API request resolved through the API catalog
Flags
--field | stringArray | Query parameter (GET) or JSON body field (key=value) |
--header | stringArray | Additional HTTP header (Name: Value) |
--input | string | Read request body from file (or - for stdin) |
--paginate | bool | Follow next_cursor across pages |
Exemplos
gotactl api GET business:/customers -f limit=5 --jsongotactl api-keys
List, create, roll, and revoke API keys for the active context
gotactl api-keys create
Create an API key in the active context (requires OAuth)
Flags
--mode | string | Key mode (live or test) |
--name | string | Key name |
--out | string | Write the secret to a 0600 file instead of stdout |
--scope | stringArray | Scope to grant (repeatable) |
--show-secret | bool | Print the secret to stdout even on a TTY |
Exemplos
gotactl api-keys create --name ci-ingest --scopes readings:write --out key.txtgotactl api-keys list
List API keys in the active context
Exemplos
gotactl api-keys list --jsongotactl api-keys revoke
Revoke an API key in the active context (requires OAuth)
Exemplos
gotactl api-keys revoke key_123gotactl api-keys roll
Roll an API key in the active context (requires OAuth)
Flags
--out | string | Write the secret to a 0600 file instead of stdout |
--overlap-seconds | int64 | Overlap duration in seconds |
--show-secret | bool | Print the secret to stdout even on a TTY |
Exemplos
gotactl api-keys roll key_123 --out key.txtgotactl auth
Authenticate and manage profiles
gotactl auth login
Sign in via device grant, browser PKCE (--web), or API key (--with-api-key)
Flags
--context | string | Sign in directly to a specific context ID |
--web | bool | Sign in using a browser and PKCE |
--with-api-key | bool | Read an API key from stdin and store it in the keychain |
gotactl auth logout
Revoke the active session and remove local credentials
gotactl auth status
Show current authentication status, profile, and issuer
gotactl auth switch
Switch the active profile in config.toml
gotactl contexts
List and switch account contexts
gotactl contexts list
List available contexts for the signed-in account
Exemplos
gotactl contexts list --jsongotactl contexts use
Switch the active OAuth session to another context
Flags
--web | bool | Use browser PKCE if interaction_required is returned |
gotactl customers
Manage customers
gotactl customers get
Get a customer by ID
Exemplos
gotactl customers get cus_123 --jsongotactl customers list
List customers
Flags
--all | bool | Fetch all pages |
--limit | int | Maximum items to return |
--search | string | Search query |
--status | string | Filter by status |
Exemplos
gotactl customers list --limit 10 --json id,display_namegotactl docs
Export the CLI command tree and metadata (use --json)
gotactl events
Trigger domain events in a sandbox
gotactl events trigger
Trigger a real domain event in the active sandbox
Flags
--list | bool | List supported event types |
Exemplos
gotactl events trigger invoice.paid
gotactl events trigger --listgotactl invoices
List and inspect invoices
gotactl invoices get
Get an invoice by ID
Exemplos
gotactl invoices get inv_123 --jsongotactl invoices list
List invoices
Flags
--account-id | string | Filter by account ID |
--all | bool | Fetch all pages |
--customer-id | string | Filter by customer ID |
--limit | int | Maximum items to return |
--status | string | Filter by status |
Exemplos
gotactl invoices list --status issued --jsongotactl openapi
Print the OpenAPI document discovered from the API catalog
gotactl organizations
List the organizations on the platform
gotactl organizations get
Get an organization by ID
Exemplos
gotactl organizations get org_123 --jsongotactl organizations list
List the organizations on the platform
Flags
--all | bool | Fetch all pages |
--limit | int | Maximum items to return |
--status | string | Filter by status |
Exemplos
gotactl organizations list --status activegotactl payments
List and inspect payments
gotactl payments get
Get a payment by ID
Exemplos
gotactl payments get pay_123 --jsongotactl payments list
List payments
Flags
--account-id | string | Filter by account ID |
--all | bool | Fetch all pages |
--invoice-id | string | Filter by invoice ID |
--limit | int | Maximum items to return |
--status | string | Filter by status |
Exemplos
gotactl payments list --limit 25 --jsongotactl plans
List the subscription plans
gotactl plans get
Get a plan by ID or code
gotactl plans list
List the subscription plans
Flags
--all | bool | Fetch all pages |
--limit | int | Maximum items to return |
Exemplos
gotactl plans listgotactl readings
List and submit meter readings
gotactl readings list
List meter readings
Flags
--account | string | Only this account (ID or number) |
--all | bool | Fetch all pages |
--limit | int | Maximum items to return |
--meter-id | string | Filter by meter ID |
Exemplos
gotactl readings list --meter-id mtr_123 --jsongotactl readings submit
Submit a meter reading
Flags
--account | string | Your account (ID or number), if you have several |
--at | string | When it was read (RFC 3339; default now) |
--meter | string | Meter ID |
--unit | string | Unit of the reading |
--value | string | Reading on the meter's dial, e.g. 512.3 |
Exemplos
gotactl readings submit --meter mtr_123 --value 42.5 --jsongotactl sandbox
Manage sandbox state and simulated payments
gotactl sandbox advance
Advance pending simulated payments or generate sandbox readings
Flags
--outcome | string | Target outcome: confirmed, failed, or expired |
--payment | string | Specific pending payment ID to advance (defaults to all pending) |
--readings | bool | Also generate a new cycle of sandbox meter readings |
Exemplos
gotactl sandbox advance
gotactl sandbox advance --payment pay_123 --outcome expiredgotactl subscriptions
List the utilities' subscriptions
gotactl subscriptions get
Get a subscription by ID
Exemplos
gotactl subscriptions get sub_123 --jsongotactl subscriptions list
List the utilities' subscriptions
Flags
--all | bool | Fetch all pages |
--limit | int | Maximum items to return |
--status | string | Filter by status |
--tenant-id | string | Filter by tenant ID |
Exemplos
gotactl subscriptions list --status past_duegotactl utilities
List the utilities on the platform
gotactl utilities get
Get a utility by tenant ID or slug
Exemplos
gotactl utilities get aguas-da-beiragotactl utilities list
List the utilities on the platform
Flags
--all | bool | Fetch all pages |
--limit | int | Maximum items to return |
Exemplos
gotactl utilities listgotactl version
Print version, commit, build date, and configured API URL
gotactl webhooks
Listen to and forward webhook events
gotactl webhooks listen
Forward domain events from the API to a local HTTP endpoint
Flags
--confirm-live | bool | Confirm listening on a live context |
--events | string | Comma-separated list of event types to forward |
--forward-to | string | Local URL to receive forwarded webhook POSTs |
--live | bool | Allow listening on a live context |
--poll-interval | duration | Polling interval, used only against servers without CLI sessions |
Exemplos
gotactl webhooks listen --forward-to http://localhost:3000/hook
gotactl webhooks listen --forward-to http://localhost:3000/hook --events invoice.paid,payment.receivedgotactl whoami
Show the current identity, active context, or API key details
Exemplos
gotactl whoami --json