{"id":18321096,"url":"https://github.com/workos/workos-cli","last_synced_at":"2025-04-05T22:32:15.769Z","repository":{"id":250756974,"uuid":"822731436","full_name":"workos/workos-cli","owner":"workos","description":"The official CLI for interacting with WorkOS APIs.","archived":false,"fork":false,"pushed_at":"2025-04-02T18:43:51.000Z","size":130,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-02T20:50:19.393Z","etag":null,"topics":["cli","command-line","workos"],"latest_commit_sha":null,"homepage":"https://workos.com/docs","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-01T17:49:00.000Z","updated_at":"2025-03-28T22:01:16.000Z","dependencies_parsed_at":"2024-12-19T22:35:39.383Z","dependency_job_id":"31cb3ce2-ad96-4526-8954-83cca377f3a5","html_url":"https://github.com/workos/workos-cli","commit_stats":null,"previous_names":["workos/workos-cli"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workos%2Fworkos-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workos%2Fworkos-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workos%2Fworkos-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workos%2Fworkos-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workos","download_url":"https://codeload.github.com/workos/workos-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411234,"owners_count":20934650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","workos"],"created_at":"2024-11-05T18:18:19.996Z","updated_at":"2025-04-05T22:32:15.487Z","avatar_url":"https://github.com/workos.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WorkOS CLI\n\n## Installation\n\n### MacOS (Homebrew)\n\n#### Install\n\n```shell\nbrew install workos/tap/workos-cli\n```\n\n#### Upgrade\n\n```shell\nbrew upgrade workos/tap/workos-cli\n```\n\n## Usage\n\nFirst, initialize the CLI:\n\n```shell\nworkos init\n```\n\nFollow the interactive prompts to configure the CLI for use with the specified environment.\n\nThe CLI can be configured to work with multiple WorkOS environments.\n\n```shell\nworkos env add\n```\n\nTo switch between environments, use the `env switch` command and select the environment you would like to switch to:\n\n```shell\nworkos env switch\n```\n\nTo remove a configured environment from the CLI, use the `env remove` command and select the environment you would like to remove:\n\n```shell\nworkos env remove\n```\n\nOnce initialized, the CLI is ready to use:\n\n```shell\nworkos [cmd] [args]\n```\n\n### Environment Variables\nWorkOS CLI support environment variables for initialization and environment management.\n\n| Environment Variable                  | Description                                                                                                                                        | Supported Values     |\n|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|\n| WORKOS_ACTIVE_ENVIRONMENT             | Sets the selected environment in your .workos.json file. Use `headless` to override environment configs with other environment variable overrides. |                      |\n| WORKOS_ENVIRONMENTS_HEADLESS_NAME     | Sets the name of the environment                                                                                                                   |                      |\n| WORKOS_ENVIRONMENTS_HEADLESS_ENDPOINT | Sets the base endpoint for the environment                                                                                                         |                      |\n| WORKOS_ENVIRONMENTS_HEADLESS_API_KEY  | Sets the API key for the environment                                                                                                               |                      |\n| WORKOS_ENVIRONMENTS_HEADLESS_TYPE     | Sets the env type for the environment                                                                                                              | Production / Sandbox |\n\n#### Examples\n\n##### Set the active environment\n\n```shell\nexport WORKOS_ACTIVE_ENVIRONMENT=local\n```\n\n`.workos.json`\n```json\n{\n  \"environments\": {\n    \"local\": {\n      \"endpoint\": \"http://localhost:8001\",\n      \"apiKey\": \"\u003cYOUR_KEY\u003e\",\n      \"type\": \"Sandbox\",\n      \"name\": \"local\"\n    }\n  }\n}\n```\n\n##### Headless Mode\n\n```shell\nexport WORKOS_ACTIVE_ENVIRONMENT=headless\nexport WORKOS_ENVIRONMENTS_HEADLESS_NAME=local\nexport WORKOS_ENVIRONMENTS_HEADLESS_ENDPOINT=http://localhost:8001\nexport WORKOS_ENVIRONMENTS_HEADLESS_API_KEY=\u003cYOUR_KEY\u003e\nexport WORKOS_ENVIRONMENTS_HEADLESS_TYPE=Sandbox\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkos%2Fworkos-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkos%2Fworkos-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkos%2Fworkos-cli/lists"}