primitivedotdev/primitive.dev - Setup CLI
Install the primitive.dev CLI (`@primitivedotdev/cli`) and configure auth so subsequent steps can run `primitive …` (or `prim …`) directly. The companion to `deploy-function` / `send-email`: one setup step unlocks the whole CLI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | Org-scoped Primitive API key. When set, it's masked and exported as `PRIMITIVE_API_KEY` for all later steps (the CLI reads it automatically). Pass via a GitHub secret (`${{ secrets.* }}`) — never hard-code. Omit only if a later step provides auth another way. | no | — |
| api-base-url | API base URL, exported as `PRIMITIVE_API_BASE_URL`. Defaults to production; override only for a non-production environment. | no | https://api.primitive.dev/v1 |
| version | npm version spec of `@primitivedotdev/cli` to install — e.g. `1` (latest 1.x), `1.0.1` (exact), or `latest`. Pin for reproducible CI. | no | latest |
| verify | Run `primitive whoami` after install to fail fast on a bad/expired key and populate the `org-id` / `email` outputs. Requires `api-key`. Default `true`. | no | true |
Outputs
| name | description |
|---|---|
| cli-version | The installed CLI version string. |
| org-id | Account/org id of the authenticated key (set only when `verify` ran). |
| Account email of the authenticated key (set only when `verify` ran). |