{"id":18263831,"url":"https://github.com/atomist/cli","last_synced_at":"2025-08-04T06:36:37.950Z","repository":{"id":55127401,"uuid":"139435760","full_name":"atomist/cli","owner":"atomist","description":"The Atomist CLI","archived":false,"fork":false,"pushed_at":"2021-01-08T04:18:16.000Z","size":2947,"stargazers_count":21,"open_issues_count":0,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-18T18:37:20.503Z","etag":null,"topics":["cli","docker","kubernetes","node"],"latest_commit_sha":null,"homepage":"","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/atomist.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2018-07-02T11:43:30.000Z","updated_at":"2025-01-28T18:49:50.000Z","dependencies_parsed_at":"2022-08-14T12:50:33.282Z","dependency_job_id":null,"html_url":"https://github.com/atomist/cli","commit_stats":null,"previous_names":[],"tags_count":857,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atomist","download_url":"https://codeload.github.com/atomist/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247246395,"owners_count":20907788,"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","docker","kubernetes","node"],"created_at":"2024-11-05T11:12:49.388Z","updated_at":"2025-04-04T20:31:23.076Z","avatar_url":"https://github.com/atomist.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Atomist CLI - `@atomist/cli`\n\n[![atomist sdm goals](https://badge.atomist.com/T29E48P34/atomist/cli/8b6783d7-2658-4ca0-b9a7-e684ad1dbcc3)](https://app.atomist.com/workspace/T29E48P34)\n[![npm version](https://badge.fury.io/js/%40atomist%2Fcli.svg)](https://badge.fury.io/js/%40atomist%2Fcli)\n\nThe Atomist CLI, a unified command-line tool for interacting with\n[Atomist][atomist] services.\n\n## Installation\n\n### Homebrew\n\nIf you are running [Homebrew][brew] on macOS, you can use it to\ninstall the Atomist CLI.\n\n```\n$ brew install atomist-cli\n```\n\n[brew]: https://brew.sh/ (Homebrew - The missing package manager for macOS)\n\n### Manually\n\nYou will need [Node.js][node] installed to run the Atomist CLI.  Once\nNode.js is installed, you can use `npm` to install the Atomist CLI.\n\n```\n$ npm install -g @atomist/cli\n```\n\n[node]: https://nodejs.org/ (Node.js)\n\n## Using\n\nTo use local software delivery machine (SDM), you will need [Git][git]\ninstalled.  See the [Local SDM][sdm-local] documentation for more\ninformation.\n\nTo interact with the Atomist API, you will need an Atomist workspace.\nSee the [Atomist Getting Started Guide][atomist-start] for\ninstructions on how to get an Atomist workspace and connect it to your\nsource code repositories, continuous integration, chat platform, etc.\nSee the [Atomist Developer Guide][atomist-dev] for more complete\ninstructions on setting up your development environment.\n\nYou can run `atomist --help` to see the standard help message.  See\nthe [Atomist developer quick start][atomist-quick-start] for more\ninformation.\n\n[git]: https://git-scm.com/ (Git)\n[sdm-local]: https://github.com/atomist/sdm-local#readme (Atomist - Local Software Delivery Machine SDM)\n[atomist-start]: https://docs.atomist.com/user/ (Atomist - Getting Started)\n[atomist-dev]: https://docs.atomist.com/developer/prerequisites/ (Atomist - Developer Prerequisites)\n[atomist-quick-start]: https://docs.atomist.com/quick-start/ (Atomist Developer Quick Start)\n\n### Configuration\n\nYou can use the Atomist CLI to configure your local environment to run\n[software delivery machines (SDMs)][sdm] and other Atomist API\nclients.\n\n```\n$ atomist config\n```\n\nSee the [Atomist developer prerequisites][atomist-dev] for more\ninformation.\n\n[sdm]: https://docs.atomist.com/ (Atomist Documentation)\n\n### Kubernetes\n\nYou can use the Atomist CLI to install the Atomist Kubernetes\nutilities in your Kubernetes cluster:\n\n```\n$ atomist kube --environment=MY_CLUSTER\n```\n\nreplacing `MY_CLUSTER` with a meaningful name for the Kubernetes\ncluster your `kubectl` utility is configured to communicate with.  See\nthe [Atomist Kubernetes documentation][atomist-k8] for more\ninformation.\n\n[atomist-k8]: https://docs.atomist.com/user/kubernetes/ (Atomist Kubernetes)\n\n### Fetch schema\n\nYou can fetch the current version of the GraphQL schema for your\nAtomist workspace using the following command.\n\n```\n$ atomist gql-fetch\n```\n\nIf you are defining custom types via registering ingestors in an SDM\nor other API client, you should download the schema in each of your\nSDM/API client projects prior to building them.\n\n## Support\n\nGeneral support questions should be discussed in the `#help`\nchannel in the [Atomist community Slack workspace][slack].\n\nIf you find a problem, please create an [issue][].\n\n[issue]: https://github.com/atomist/cli/issues\n\n## Development\n\nYou will need to install [node][] to build and test this project.\n\n[node]: https://nodejs.org/ (Node.js)\n\n### Build and Test\n\nUse the following package scripts to build, test, and perform other\ndevelopment tasks.\n\nCommand | Reason\n------- | ------\n`npm install` | install project dependencies\n`npm run build` | compile, test, lint, and generate docs\n`npm start` | start the Atomist CLI\n`npm run lint` | run TSLint against the TypeScript\n`npm run compile` | compile TypeScript\n`npm test` | run tests\n`npm run autotest` | run tests every time a file changes\n`npm run clean` | remove files generated during the build\n\n### Release\n\nReleases are managed by the [Atomist SDM][atomist-sdm].  Press the\nrelease button in the Atomist dashboard or Slack.\n\n[atomist-sdm]: https://github.com/atomist/atomist-sdm (Atomist Software Delivery Machine)\n\n---\n\nCreated by [Atomist][atomist].\nNeed Help?  [Join our Slack workspace][slack].\n\n[atomist]: https://atomist.com/ (Atomist - How Teams Deliver Software)\n[slack]: https://join.atomist.com/ (Atomist Community Slack Workspace) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatomist%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist%2Fcli/lists"}