Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.23.0"
".": "0.24.0"
}
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.24.0](https://github.com/workos/cli/compare/v0.23.0...v0.24.0) (2026-10-21)


### ⚠ BREAKING CHANGES

* The npm package no longer exports a library API — `main`/`exports` are gone and it only provides the `workos` binary. Development now requires Bun >= 1.3.0 instead of Node >= 22.11.

### Features

* Download migrations and emulate bundles at runtime ([#203](https://github.com/workos/cli/issues/203)) ([b07f661](https://github.com/workos/cli/commit/b07f661f4f647c6afee5b9184a7507cb1fe418e8))
* **skills:** offer to update stale skills after commands ([#237](https://github.com/workos/cli/issues/237)) ([6f27596](https://github.com/workos/cli/commit/6f275967d1e2bc130ca695a052068f107c0b5bf1))
* switch installer to Claude Opus 5.5 and bump @workos/skills to 0.8.0 ([#265](https://github.com/workos/cli/issues/265)) ([d7912fa](https://github.com/workos/cli/commit/d7912fa7ee5eac0a42fb9c98da8f46400619b458))


### Bug Fixes

* **installer:** coordinate spinner and prompt ownership ([#256](https://github.com/workos/cli/issues/256)) ([098ddb0](https://github.com/workos/cli/commit/098ddb0bec4a9ef29a4dc6cb6a7b911514c9550b))
* **installer:** give the agent its rules, unbreak non-JS installs, and run evals through the real installer ([#266](https://github.com/workos/cli/issues/266)) ([8b223d6](https://github.com/workos/cli/commit/8b223d6aa9f2e24bee8583a8a163fbbb6d71d414))
* **installer:** recover unauthorized dashboard configuration safely ([#255](https://github.com/workos/cli/issues/255)) ([28e3ce4](https://github.com/workos/cli/commit/28e3ce4d94117d1c8b88558dbbf7492a598a6d3f))
* **installer:** remove commit and pull request prompts ([#257](https://github.com/workos/cli/issues/257)) ([4da43d9](https://github.com/workos/cli/commit/4da43d9520267603335120e984a3ebdd528cc502))
* **installer:** stop loading user Claude Code settings in the installer agent ([#267](https://github.com/workos/cli/issues/267)) ([0d2a1c3](https://github.com/workos/cli/commit/0d2a1c38f969f403ee9c5a31935a14514d8b20c2))
* **ruby:** improve Rails setup and prepare Fizzy acceptance ([#258](https://github.com/workos/cli/issues/258)) ([dea3326](https://github.com/workos/cli/commit/dea3326b3e04d43637f8e4e7ad93d070598e61d2))

## [0.23.0](https://github.com/workos/cli/compare/v0.22.0...v0.23.0) (2026-09-25)


Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,9 @@ The remaining commands (`connection`, `directory`, `audit-log`, `api-key`, `vaul

#### GitHub Actions without an API key (workload identity federation)

> Preview: the WorkOS server side is still being built (behind the `management-api-oauth` flag) and has no production endpoint yet.
> Preview: the WorkOS server side is still being built (behind the `workos-api-workload-identity` and `management-api-oauth` flags) and has no production endpoint yet.

In a GitHub Actions job with `permissions: id-token: write`, `WORKOS_CLIENT_ID` set to an M2M application's client ID, and no `WORKOS_API_KEY`, the REST commands above (plus `seed`, `setup-org`, `onboard-user`, `debug-sso`, `debug-sync`) exchange the job's GitHub OIDC token at `WORKOS_WIF_TOKEN_URL` for a short-lived WorkOS access token. The token is held in memory only and refreshed before it expires. `verify-login` refuses WIF tokens because it can't confirm the environment isn't production, and `migrations` ignores WIF. See [`examples/wif-github-actions`](examples/wif-github-actions/) for a workflow and setup guide.
In a GitHub Actions job with `permissions: id-token: write`, `WORKOS_CLIENT_ID` set to an M2M application's client ID, and no `WORKOS_API_KEY`, the REST commands above (plus `seed`, `setup-org`, `onboard-user`, `debug-sso`, `debug-sync`) exchange the job's GitHub OIDC token at `WORKOS_WIF_TOKEN_URL` for a short-lived WorkOS access token. What that token may do is decided by the server and by the scopes the M2M application holds. Today the server offers scopes for reading and creating organizations and for reading connections, directories, users and events. A command that needs anything else (for example `api-key`, `vault` or `audit-log`) is refused by the API, and the CLI says that the WIF token was refused. A job that has a stored profile key and no `WORKOS_WIF_TOKEN_URL` keeps using the stored key. The token is held in memory only and refreshed before it expires. A token exchange that hits a network error or a 5xx is retried up to three times in total, each with a fresh GitHub OIDC token, and an API call answered with 401 is re-sent once with a newly exchanged token. `verify-login` does not use WIF, because it can't confirm the environment isn't production, and `migrations` ignores WIF. See [`examples/wif-github-actions`](examples/wif-github-actions/) for a workflow and setup guide.

#### organization

Expand Down Expand Up @@ -694,9 +694,9 @@ workos install --api-key sk_test_xxx --client-id client_xxx 2>/dev/null
| `WORKOS_API_KEY` | API key for `workos api`, the still-REST commands (connection, directory, audit-log, api-key, vault), and workflow/debug commands. Resource commands use the `workos auth login` session instead |
| `WORKOS_CLIENT_ID` | In GitHub Actions with no API key: the M2M application's client ID, which turns on workload identity federation for the REST commands |
| `WORKOS_WIF_TOKEN_URL` | Workload identity federation token endpoint (`https://<your AuthKit domain>/oauth2/token`). Required for WIF; no default until the server side ships |
| `WORKOS_WIF_AUDIENCE` | Audience requested for the GitHub OIDC token (default `https://api.workos.com`); must match the M2M application's trust rule |
| `WORKOS_WIF_AUDIENCE` | Audience requested for the GitHub OIDC token (default `https://api.workos.com`); must be the M2M application's audience |
| `WORKOS_WIF_SCOPE` | Optional `scope` sent with the WIF token exchange |
| `WORKOS_ENVIRONMENT_ID` | Sent as `x-url-environment-id` with WIF access tokens; machine tokens need it |
| `WORKOS_ENVIRONMENT_ID` | Optional. Sent as `x-url-environment-id` with WIF access tokens; when set it must be the environment the M2M application is bound to |
| `WORKOS_API_URL` | Override the API base URL for all CLI commands (e.g. a local API) |
| `WORKOS_API_BASE_URL` | Accepted alias for `WORKOS_API_URL` (what `workos dev` sets) |
| `WORKOS_MODE` | Interaction mode: `human`, `agent`, or `ci` |
Expand Down
5 changes: 3 additions & 2 deletions examples/wif-github-actions/.github/workflows/wif-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
# workload identity federation (WIF): the job's GitHub OIDC token is exchanged
# for a short-lived WorkOS access token. See ../../README.md for setup.
#
# The WorkOS server side (the `management-api-oauth` flag) is not deployed
# yet, so this only works against an environment where it has been enabled.
# The WorkOS server side (the `workos-api-workload-identity` and
# `management-api-oauth` flags) is not deployed yet, so this only works for a
# team where it has been enabled.

name: WorkOS WIF test

Expand Down
Loading
Loading