{"id":18656603,"url":"https://github.com/zendesk/zcli","last_synced_at":"2025-04-06T12:08:00.425Z","repository":{"id":37179415,"uuid":"283902843","full_name":"zendesk/zcli","owner":"zendesk","description":"A command-line tool for Zendesk ","archived":false,"fork":false,"pushed_at":"2024-12-18T14:57:52.000Z","size":6887,"stargazers_count":65,"open_issues_count":66,"forks_count":24,"subscribers_count":219,"default_branch":"master","last_synced_at":"2025-03-30T11:06:29.867Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://developer.zendesk.com","language":"TypeScript","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/zendesk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-31T00:13:50.000Z","updated_at":"2025-02-13T12:59:17.000Z","dependencies_parsed_at":"2023-02-12T19:30:56.686Z","dependency_job_id":"460f8532-2cfb-4dfa-921b-55c12603ed84","html_url":"https://github.com/zendesk/zcli","commit_stats":null,"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Fzcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zendesk","download_url":"https://codeload.github.com/zendesk/zcli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478320,"owners_count":20945266,"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-07T07:24:18.633Z","updated_at":"2025-04-06T12:08:00.402Z","avatar_url":"https://github.com/zendesk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"logo.png\" alt=\"Zendesk Logo\" width=\"100\"/\u003e\n\n# ZCLI\n\n[![npm version](https://badge.fury.io/js/%40zendesk%2Fzcli.svg)](https://www.npmjs.com/package/@zendesk/zcli)\n![Test](https://github.com/zendesk/zcli/workflows/Test/badge.svg)\n\nZCLI is a Zendesk CLI which helps you build and manage your Zendesk apps and themes from the command line. ZCLI is currently available in beta and is built using the [oclif](https://github.com/oclif/oclif) framework.\n\n\u003cimg src=\"demo.gif\" alt=\"Zendesk Logo\" /\u003e\n\nFor more about ZCLI see [the full documentation.](/docs)\n\n# Getting started\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the [npm registry.](https://www.npmjs.com/package/@zendesk/zcli)\n\nBefore installing, download and install Node.js. Node.js v20.17.0 or higher is required. Installation is done using the `yarn` install command:\n\n```\n$ yarn global add @zendesk/zcli\n```\n\n## Installation prerequisites for Linux\n\nCurrently ZCLI has a dependency on `libsecret` to save authentication information securely in the operating system's keychain.\n\nDepending on your distribution, you will need to run one of the following commands prior to installing ZCLI:\n- Debian/Ubuntu: `sudo apt install libsecret-1-dev`\n- Red Hat-based: `sudo yum install libsecret-devel`\n- Arch Linux: `sudo pacman -S libsecret`\n\n\n## Note for environments without Linux window manager (X11) support\nZCLI's credential manager has a dependency on Linux's windowing manager (X11) which will cause some commands to fail to run on an environment without window manager support. These commands include: `zcli login`, `zcli logout` and `zcli profiles`.\n\n### For headless Linux in a Docker container\n- Install  `gnome-keyring`, `dbus-x11` and the corresponding libsecret package listed above\n- Launch `dbus`\n```\nexport $(dbus-launch)\n```\n- Unlock the Gnome keyring daemon with a dummy password\n```\necho \"123456\" | gnome-keyring-daemon  -r --unlock --components=secrets\n```\n\nRefer to this sample [Dockerfile](/example/headless_ubuntu_zcli.Dockerfile) to see how you can run ZCLI on a headless installation of Ubuntu.\n### For Windows users running Linux on WSL\n\nWSL2 now [supports running Linux GUI application](https://docs.microsoft.com/en-us/windows/wsl/tutorials/gui-apps). For users unable to upgrade to WSL2, there are a number of workarounds available:\n\n* Manually starting a DBus session and unlocking the Gnome keyring with a password supplied via STDIN(similar to headless docker above)\n* Using X11 forwarding to be able to enable the Gnome keyring prompt to display\n\n\n\n# Commands\n\nZCLI supports numerous commands. Further documentation on available commands can be found [here.](/docs)\n\n- [`$ zcli apps`](/docs/apps.md) - manage zendesk apps workflow.\n- [`$ zcli themes`](/docs/themes.md) - manage zendesk themes workflow.\n- [`$ zcli profiles`](/docs/profiles.md) - manage zcli profiles.\n- [`$ zcli login`](/docs/login.md) - login to zendesk account.\n- [`$ zcli logout`](/docs/logout.md) - logout and remove active profile.\n- [`$ zcli autocomplete`](/docs/autocomplete.md) - display autocomplete installation instructions.\n- [`$ zcli help`](/docs/help.md) - display help for zcli\n\n# Local development\n\nTo run your development copy of ZCLI locally, execute `yarn link:bin`.\n\nUnder macOS if you are using a version manager like [`asdf`](https://asdf-vm.com), it can additionally set up the global `/usr/local/bin/zcli`.\nNote you need global Node.js and [`ts-node`](https://github.com/TypeStrong/ts-node) for this as well.\n\n```sh\nbrew install --formula node yarn\nyarn global add ts-node\n```\n\nUnder Windows this can only be used in WSL2 or [Cygwin](https://www.cygwin.com).\n\n# Contributing\n\n---\n\n**Note:** While ZCLI is in beta, we are not routinely reviewing issues and merging community-submitted pull requests. We hope to begin reviewing these again soon, but for the moment we appreciate your patience.\n\n---\n\nThanks for your interest in ZCLI! Community involvement helps improve the experience for all developers using the Zendesk platform.\n\nGot issues with what you find here? You can [create an issue on Github](https://github.com/zendesk/zcli/issues/new), report the issue in the [Zendesk Developers Slack group](https://docs.google.com/forms/d/e/1FAIpQLScm_rDLWwzWnq6PpYWFOR_PwMaSBcaFft-1pYornQtBGAaiJA/viewform), or for other problems, [contact Zendesk Customer Support](https://support.zendesk.com/hc/en-us/articles/360026614173).\n\nIf you'd like to take a crack at making some changes, please refer to [our contributing guide](.github/CONTRIBUTING.md).\n\n# ZAF App Scaffolding\n\nSome useful app scaffolds for build ZAF apps that incorporate the ZCLI tool are avaliable at [zendesk/app_scaffolds](https://github.com/zendesk/app_scaffolds)\n\n# Releasing\n\nRunning the following command will create release tags, generate change logs docs and publish to npm.\n\n[`$ ./scripts/release.sh`](./scripts/release.sh)\n\n# License\n\nCopyright 2022 Zendesk, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fzcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzendesk%2Fzcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Fzcli/lists"}