@cloudsignal/cli
v0.2.6
Published
CloudSignal CLI — manage MQTT access-control policies and identity claims
Readme
@cloudsignal/cli
Admin/ops command-line tool for CloudSignal. Manage your MQTT access-control (ACL) policies and identity claims, and handle operator login — from your terminal or CI.
Building an application? This is an admin CLI, not a client library. To connect to the broker, publish, subscribe, or receive messages from app code, use
@cloudsignal/mqtt-client(or a feature SDK such as@cloudsignal/notifications, which depends on it as a peer). This package has no client API and should not be imported.
Install
# Global (operators)
npm install -g @cloudsignal/cli
# One-off / CI
npx @cloudsignal/cli <command>Binary name: cloudsignal.
Authentication
cloudsignal login # browser-based OAuth/PKCE login
cloudsignal whoami # show current email, organization, token expiry
cloudsignal logout # clear stored credentialsCredentials are stored in ~/.cloudsignal/credentials.json (mode 0600) and the access token is refreshed automatically. Set CLOUDSIGNAL_HOME to change the config directory and CLOUDSIGNAL_API_URL to point at a different Management API.
Commands
ACL policies
cloudsignal acl get [--pretty] [--compact]
cloudsignal acl validate <file> [--local-only]
cloudsignal acl update <file> [--skip-local-validation] [--dry-run]
cloudsignal acl simulate --user <id> --topic <topic> --action <publish|subscribe> \
[--qos 0|1|2] [--client-id <id>] [--username <name>]A deployable policy must set version: "2" and default: "deny". Use acl validate or acl update --dry-run before deploying.
Identity claims
Claims are key/value attributes consumed by ACL binding rules.
cloudsignal user claims show <user> [--json]
cloudsignal user claims set <user> <key=value>... [--json]
cloudsignal user claims unset <user> <key> [--json]<user> accepts a user UUID or an mqtt_username.
Hosts
The CLI talks to the Management API at https://api.cloudsignal.app (override with CLOUDSIGNAL_API_URL). Organization ids use the org_short_id format (org_ + 12 chars), e.g. org_k7xm4pqr2n5t.
AI agents
Machine-readable integration guidance lives in PROMPT.md and llms.txt.
License
MIT
