{"id":21393244,"url":"https://github.com/camunda-community-hub/zbctl-snap","last_synced_at":"2025-07-13T18:31:46.888Z","repository":{"id":44029740,"uuid":"458607935","full_name":"camunda-community-hub/zbctl-snap","owner":"camunda-community-hub","description":"Snap package of zbctl (the command-line client for Camunda Platform 8) allowing easy installation and automatic updates on Linux.","archived":false,"fork":false,"pushed_at":"2024-09-16T15:10:10.000Z","size":123,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-09-17T18:28:20.121Z","etag":null,"topics":["autoupdate","camunda","camunda-cloud-cli","camunda-cloud-client","camunda-platform-8","cli","cli-app","cli-application","cloud","installation","zeebe","zeebe-client","zeebe-tool","zeebe-worker"],"latest_commit_sha":null,"homepage":"https://snapcraft.io/zbctl","language":"Shell","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/camunda-community-hub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.MD","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.MD","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":"2022-02-12T18:37:00.000Z","updated_at":"2024-09-16T15:10:15.000Z","dependencies_parsed_at":"2024-07-12T18:56:14.739Z","dependency_job_id":null,"html_url":"https://github.com/camunda-community-hub/zbctl-snap","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda-community-hub%2Fzbctl-snap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda-community-hub%2Fzbctl-snap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda-community-hub%2Fzbctl-snap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda-community-hub%2Fzbctl-snap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/camunda-community-hub","download_url":"https://codeload.github.com/camunda-community-hub/zbctl-snap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225908931,"owners_count":17543489,"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":["autoupdate","camunda","camunda-cloud-cli","camunda-cloud-client","camunda-platform-8","cli","cli-app","cli-application","cloud","installation","zeebe","zeebe-client","zeebe-tool","zeebe-worker"],"created_at":"2024-11-22T14:10:50.132Z","updated_at":"2024-11-22T14:10:50.542Z","avatar_url":"https://github.com/camunda-community-hub.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Community Extension](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community)\n![Compatible with: Camunda Platform 8](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%208-0072Ce)\n[![](https://img.shields.io/badge/Lifecycle-Incubating-blue)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#incubating-)\n\n# zbctl via Snap\n\n[![zbctl](https://snapcraft.io/zbctl/badge.svg)](https://snapcraft.io/zbctl)\n[![zbctl](https://snapcraft.io/zbctl/trending.svg?name=0)](https://snapcraft.io/zbctl)\n\nZeebe CLI via [Snap](https://snapcraft.io/).\n\nThis is a [Snap](https://snapcraft.io/about) package of\n[zbctl](https://docs.camunda.io/docs/apis-clients/cli-client/index/) (the command-line client for [Camunda Platform 8](https://camunda.com)).\n\nWith this you can easily install zbctl on Linux and keep it up to date through the automatic updater of your distro. The package also shows up if you search for 'Camunda' or 'Zeebe' in your package manager, e.g. 'Ubuntu Software' desktop app.\n\n![Screenshot showing zbctl in the Ubuntu Software app](screen.jpg)\n\nThe snap build is based the official zbctl binaries from the GitHub release page. However, the fully automated build infrastructure provided for free by Snapcraft would also allow cross compilation to currently unsupported CPU architectures. For such a multi-platform build one would have to build from the go sources. The next tools to package like this would be Camunda Modeler and zdb.\n\n## Installation\n\n[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/zbctl)\n\n```sh\nsnap install zbctl\n```\n\n## Updating\n\n```sh\nsnap refresh zbctl\n```\n\n## Testing alpha releases\n\n```sh\nsnap install zbctl --channel=beta\n```\n\n## Usage\n\n[Official zbctl documentation](https://docs.camunda.io/docs/apis-clients/cli-client/index/)\n\n```\nzbctl [options] [command]\n```\n\n```\nzbctl is a command line interface for Camunda Platform 8 designed to create and read resources inside a Zeebe broker.\nIt can be used for regular development and maintenance tasks such as:\n        * Deploying processes\n        * Creating process instances and job workers\n        * Activating, completing, or failing jobs\n        * Updating variables and retries\n        * Viewing cluster status\n\nUsage:\n  zbctl [command]\n\nAvailable Commands:\n  activate    Activate a resource\n  cancel      Cancel resource\n  complete    Complete a resource\n  create      Create resources\n  deploy      Creates new workflow defined by provided BPMN or YAML file as workflowPath\n  fail        Fail a resource\n  generate    Generate documentation\n  help        Help about any command\n  publish     Publish a message\n  resolve     Resolve a resource\n  set         Set a resource\n  status      Checks the current status of the cluster\n  update      Update a resource\n  version     Print the version of zbctl\n\nFlags:\n      --address string        Specify a contact point address. If omitted, will read from the environment variable 'ZEEBE_ADDRESS' (default '127.0.0.1:26500')\n      --audience string       Specify the resource that the access token should be valid for. If omitted, will read from the environment variable 'ZEEBE_TOKEN_AUDIENCE'\n      --authzUrl string       Specify an authorization server URL from which to request an access token. If omitted, will read from the environment variable 'ZEEBE_AUTHORIZATION_SERVER_URL' (default \"https://login.cloud.camunda.io/oauth/token/\")\n      --certPath string       Specify a path to a certificate with which to validate gateway requests. If omitted, will read from the environment variable 'ZEEBE_CA_CERTIFICATE_PATH'\n      --clientCache string    Specify the path to use for the OAuth credentials cache. If omitted, will read from the environment variable 'ZEEBE_CLIENT_CONFIG_PATH' (default \"/Users/sitapati/.camunda/credentials\")\n      --clientId string       Specify a client identifier to request an access token. If omitted, will read from the environment variable 'ZEEBE_CLIENT_ID'\n      --clientSecret string   Specify a client secret to request an access token. If omitted, will read from the environment variable 'ZEEBE_CLIENT_SECRET'\n  -h, --help                  help for zbctl\n      --insecure              Specify if zbctl should use an unsecured connection. If omitted, will read from the environment variable 'ZEEBE_INSECURE_CONNECTION'\n\nUse \"zbctl [command] --help\" for more information about a command.\n```\n\n## Updating the Snap package\n\nIf you want to submit a PR to update the package with a newer version of `zbctl`, you need to:\n\n1. Run `./update.sh` which will:\n    1. Fetch that latest Zeebe version number from the [Zeebe release page](https://github.com/camunda/camunda/releases) using `gh`.\n    1. Update the package version in `snap/snapcraft.yaml` to match the Zeebe release version.\n    1. Update the `source-checksum` with the value of the `camunda-zeebe-*.tar.gz.sha1sum` file from the [Zeebe release page](https://github.com/camunda/camunda/releases).\n1. Test locally\n    1. Build the package locally by running `snapcraft`.\n    1. Test the installation using `snap install zbctl_*_amd64.snap --dangerous`\n1. Push to GitHub.\n1. Once a pull request is merged to the main branch, Snapcraft will automatically build the package and publish it to the `edge` channel.\n1. From there it can be installed and tested using:\n    ```sh\n    snap refresh zbctl --channel=edge\n    zbctl version\n    zbctl status\n    ```\n1. @falko promotes the package to the `stable` channel on the [Snap Store](https://snapcraft.io/zbctl/releases) after the [build](https://snapcraft.io/zbctl/builds) has finished.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcamunda-community-hub%2Fzbctl-snap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcamunda-community-hub%2Fzbctl-snap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcamunda-community-hub%2Fzbctl-snap/lists"}