{"id":15692352,"url":"https://github.com/mamantoha/zci","last_synced_at":"2025-05-07T23:08:19.990Z","repository":{"id":32901473,"uuid":"36496198","full_name":"mamantoha/zci","owner":"mamantoha","description":"Zendesk and Crowdin integration Command Line Interface (CLI)","archived":false,"fork":false,"pushed_at":"2019-09-13T10:54:08.000Z","size":78,"stargazers_count":7,"open_issues_count":3,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-07T23:08:14.347Z","etag":null,"topics":["cli","crowdin","ruby","zendesk"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mamantoha.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}},"created_at":"2015-05-29T10:00:39.000Z","updated_at":"2020-12-18T11:13:38.000Z","dependencies_parsed_at":"2022-08-07T18:16:08.648Z","dependency_job_id":null,"html_url":"https://github.com/mamantoha/zci","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/mamantoha%2Fzci","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzci/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzci/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mamantoha%2Fzci/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mamantoha","download_url":"https://codeload.github.com/mamantoha/zci/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252968118,"owners_count":21833251,"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","crowdin","ruby","zendesk"],"created_at":"2024-10-03T18:31:59.579Z","updated_at":"2025-05-07T23:08:19.971Z","avatar_url":"https://github.com/mamantoha.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZCI\n\n[![Gem Version](http://img.shields.io/gem/v/zci.svg?style=flat)](http://rubygems.org/gems/zci)\n\nZendesk and Crowdin integration Command Line Interface (CLI)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'zci'\n```\n\nAnd then execute:\n\n```console\nbundle\n```\n\nOr install it manually as:\n\n```console\ngem install zci\n```\n\n## Use\n\nThe simplest way to get started is to create a scaffold project:\n\n```console\nzci init todo\n```\n\nA new ./todo directory is created with the sample config `zci.yml`. View the basic output of the scaffold with:\n\n```console\ncd todo\nzci help\n```\n\nWhich will output:\n\n```console\nNAME\n    zci - is a command line tool that allows you to manage and synchronize your Zendesk localization with Crowdin project\n\nSYNOPSIS\n    zci [global options] command [command options] [arguments...]\n\nVERSION\n    0.6.1\n\nGLOBAL OPTIONS\n    -c, --config=\u003cs\u003e - Project-specific configuration file (default: /home/crowdin/zci.yml)\n    --version        - Display the program version\n    -v, --verbose    - Be verbose\n    --help           - Show this message\n\nCOMMANDS\n    help                  - Shows a list of commands or help for one command\n    init:project          - Create new ZCI-based project\n    import:sources        - Read categories/section/articles from Zendesk and upload resource files to Crowdin\n    download:translations - Build and download translation resources from Crowdin\n    export:translations   - Add or update localized resource files(categories, sections and articles) in Zendesk\n    clean                 - Clears out the local repository of retrieved files\n    project:info          - Zendesk and Crowdin info\n```\n\n## Configuration\n\nThe scaffold project that was created in ./todo comes with a `zci.yml` shell.\n\n```yaml\n---\n# Crowdin API credentials\ncrowdin_project_id: '{{crowdin-project-id}}'\ncrowdin_api_key: '{{crowdin-project-api-key}}'\ncrowdin_base_url: 'https://api.crowdin.com'\n\n# Zendesk API credentials\nzendesk_base_url: 'https://{{subdomain}}.zendesk.com/api/v2/'\nzendesk_username: '{{zendesk-admin-username}}'\nzendesk_password: '{{zendesk-admin-password}}'\n\n# Zendesk catogories\ncategories:\n- zendesk_category: '{{zendesk-category-id}}'\n  translations:\n    -\n      crowdin_language_code: '{{crowdin-language-code}}' #the full list of language codes: https://support.crowdin.com/api/language-codes/\n      zendesk_locale: '{{zendesk-locale}}' #the full list of language codes: https://support.zendesk.com/hc/en-us/articles/203761906-Language-codes-for-Zendesk-supported-languages\n    -\n      crowdin_language_code: '{{crowdin-language-code}}'\n      zendesk_locale: '{{zendesk-locale}}'\n- zendesk_category: '{{zendesk-category-id}}'\n  translations:\n    -\n      crowdin_language_code: '{{crowdin-language-code}}'\n      zendesk_locale: '{{zendesk-locale}}'\n    -\n      crowdin_language_code: '{{crowdin-language-code}}'\n      zendesk_locale: '{{zendesk-locale}}'\n```\n\n## Advance Usage\n\nThis section covers some of `zci` more advanced features.\n\n### Brands\n\nTo make changes and updates via the `Help Center API` in your branded `Help Centers`, specify the URL of the specific brand.\n\nFor more information, see [Managing multiple brands](https://support.zendesk.com/hc/en-us/articles/204577973-Managing-multiple-brands-Professional-Add-on-and-Enterprise-).\n\n```yaml\n---\ncategories:\n- zendesk_category: '\u003c%zendesk-category-id%\u003e'\n  brand_url: '\u003c%zendesk-brand-url%\u003e/api/v2/'\n```\n\n## Supported Rubies\n\nTested with the following Ruby versions:\n\n- MRI 2.2.3 (Windows)\n- MRI 2.4.1 (Linux/macOS)\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Added some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## License and Author\n\nAuthor: Anton Maminov (anton.maminov@gmail.com)\n\nCopyright: 2015-2019 [crowdin.com](http://crowdin.com/)\n\nThis project is licensed under the MIT license, a copy of which can be found in the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamantoha%2Fzci","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmamantoha%2Fzci","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmamantoha%2Fzci/lists"}