{"id":19196886,"url":"https://github.com/kurrent-io/esc","last_synced_at":"2025-10-16T21:15:26.910Z","repository":{"id":42044583,"uuid":"270689309","full_name":"EventStore/esc","owner":"EventStore","description":"Event Store Cloud CLI","archived":false,"fork":false,"pushed_at":"2024-06-12T00:00:42.000Z","size":557,"stargazers_count":16,"open_issues_count":6,"forks_count":3,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-06-13T02:53:10.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EventStore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-06-08T13:59:03.000Z","updated_at":"2024-06-12T14:12:16.000Z","dependencies_parsed_at":"2023-11-29T19:32:45.609Z","dependency_job_id":"31d3728e-c332-4669-829c-61361cff0814","html_url":"https://github.com/EventStore/esc","commit_stats":null,"previous_names":[],"tags_count":249,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EventStore%2Fesc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EventStore%2Fesc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EventStore%2Fesc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EventStore%2Fesc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EventStore","download_url":"https://codeload.github.com/EventStore/esc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223823132,"owners_count":17208947,"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":[],"created_at":"2024-11-09T12:14:43.917Z","updated_at":"2025-10-16T21:15:26.517Z","avatar_url":"https://github.com/EventStore.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Event Store Cloud CLI\n\n`esc` is a command-line tool that allows you to access Event Store Cloud API in the comfort of your terminal.\n\n## Authentication\n\nIf you use `esc` for the first time, you need to generate a token first. By default, `esc` will interactively\nask your email and password to create your token.\n\nIf you prefer to have a non-interactive way to create your token, enter that command instead:\n\n```\nesc access tokens create --email \u003cemail\u003e --unsafe-password \u003cpassword\u003e\n```\n\n`esc` will refresh your token automatically without you needing to do anything. Rest assured that\n`esc` doesn't store your password in your system.\n\n## Scripting / Continuous Integration (CI) Usage\n\n`esc` exposes `--refresh-token=\u003cyour refresh token\u003e` parameter to ease scripting integration. If set, `esc` won't rely\non the filesystem to fetch your refresh token. Your refresh token won't be persisted on the filesystem neither.\n\n## Implicit parameters\n\nVirtually all commands require `--org-id` and `--project-id` parameters. It is possible to tell\n`esc` to use a preset `--org-id` or `--project-id`. You only need to create a local profile.\n\n```\nesc profiles set --profile \u003cprofile\u003e --name \u003cname\u003e --value \u003cvalue\u003e\n```\n\nFor example if you want to set a default `--org-id` for a profile named `my_profile`:\n\n```\nesc profiles set --profile my_profile --name org-id --value \u003cmy-org-id\u003e\n```\n\nSimilarly, if you want to set a default `--project-id` do:\n\n```\nesc profiles set --profile my_profile --name project-id --value \u003cmy-project-id\u003e\n```\n\nDon't forget to set your local `my_profile` profile to be the default profile by doing the following:\n\n```\nesc profiles default set --value my_profile\n```\n\nFrom now, all the commands that need `--org-id` or `--project-id` will pick the value set in your\n`my_profile` profile.\n\nYou can find more information about `profiles` by entering:\n\n```\nesc profiles --help\n```\n\n## Output Formats\n\nThis tool has historically shown output using it's own custom format instead of what the API returns. This will be deprecated in the future.\n\nTo view all the data returned from the API, pass `--fmt api`.\n\nIt is possible to tell `esc` to always use this format by setting it in your profile:\n\n```\nesc profiles set --profile my_profile --name fmt --value api\n```\n\n## JSON commands output rendering\n\nYou can render any read command output in JSON by using the `--json` flag.\n\n```\nesc resources organizations list --json\n```\n\n## Shell completions\n\nYou can generate shell completion script by using the `generate-{shell}-completion` command. Currently supported:\n\n- Bash\n- Zsh\n- Powershell\n\nAdditional shells can be supported, please open a feature request.\n\nThe content of the script is displayed on STDOUT.\n\nExample:\n\n```\nesc generate-bash-completion \u003e /usr/share/bash-completion/completions/esc.bash\n```\n\n## Common usage examples:\n\n### Create a network.\n\n```\nesc infra networks create  --cidr-block \u003ccidr-block\u003e --description \u003cdescription\u003e --provider \u003cprovider\u003e --region \u003cregion\u003e\n```\n\nYou can find out more about each option by entering:\n\n```\nesc infra networks create --help\n```\n\n### Create a peering link.\n\n```\nesc infra peerings create --org-id \u003corg-id\u003e --project-id \u003cproject-id\u003e --description \u003cdescription\u003e --peer-account-id \u003cpeer-account-id\u003e --peer-network-id \u003cpeer-network-id\u003e --peer-network-region \u003cpeer-network-region\u003e\n\n```\n\nYou can find out more about each option by entering:\n\n```\nesc infra peerings create --help\n```\n\n### Create a cluster.\n\n```\nesc mesdb clusters create --org-id \u003corg-id\u003e --project-id \u003cproject-id\u003e --description \u003cdescription\u003e --disk-size-in-gb \u003cdisk-size-in-gb\u003e --disk-type \u003cdisk-type\u003e --instance-type \u003cinstance-type\u003e --network-id \u003cnetwork-id\u003e --projection-level \u003cprojection-level\u003e --server-version \u003cserver-version\u003e --topology \u003ctopology\u003e\n```\n\nYou can find out more about each option by entering:\n\n```\nesc mesdb clusters create --help\n```\n\n### Stop a cluster\n\n```\nesc mesdb clusters stop --org-id \u003corg-id\u003e --project-id \u003cproject-id\u003e --id \u003ccluster-id\u003e\n```\n\n### Start a cluster\n\n```\nesc mesdb clusters start --org-id \u003corg-id\u003e --project-id \u003cproject-id\u003e --id \u003ccluster-id\u003e\n```\n\n### Create a shared cluster\n\n```\nesc mesdb shared-clusters create --deployment-tier s0 --name \u003cname\u003e --projection-level \u003cprojection-level\u003e --provider \u003cprovider\u003e --region \u003cregion\u003e --server-version \u003cserver-version\u003e --topology \u003ctopology\u003e --acl-id \u003cacl-id\u003e\n```\n\n### Create a refresh token.\n\n(example: for use with terraform)\n\n```\nesc access tokens create --email \u003cemail\u003e\n```\n\nYou can display your current refresh token with:\n\n```\nesc access tokens display\n```\n\n### Update Organization MFA requirement\n\n```\nescp resources organizations update-mfa-status --enabled=true\n```\n\n### List members of an organization.\n\n```\nesc access members list\n```\n\n### Enable a member of an organization\n\n```\nesc access members update --id \u003cmember-id\u003e --active true\n```\n\n### Disable a member of an organization\n\n```\nesc access members update --id \u003cmember-id\u003e --active false\n```\n\n### Deletes a member from an organization\n\n```\nesc access members delete --id \u003cmember-id\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkurrent-io%2Fesc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkurrent-io%2Fesc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkurrent-io%2Fesc/lists"}