Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atomist/cli
The Atomist CLI
https://github.com/atomist/cli
cli docker kubernetes node
Last synced: 11 days ago
JSON representation
The Atomist CLI
- Host: GitHub
- URL: https://github.com/atomist/cli
- Owner: atomist
- License: apache-2.0
- Created: 2018-07-02T11:43:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-08T04:18:16.000Z (almost 4 years ago)
- Last Synced: 2024-10-30T09:22:28.286Z (17 days ago)
- Topics: cli, docker, kubernetes, node
- Language: TypeScript
- Homepage:
- Size: 2.81 MB
- Stars: 20
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Atomist CLI - `@atomist/cli`
[](https://app.atomist.com/workspace/T29E48P34)
[](https://badge.fury.io/js/%40atomist%2Fcli)
The Atomist CLI, a unified command-line tool for interacting with
[Atomist][atomist] services.
## Installation
### Homebrew
If you are running [Homebrew][brew] on macOS, you can use it to
install the Atomist CLI.
```
$ brew install atomist-cli
```
[brew]: https://brew.sh/ (Homebrew - The missing package manager for macOS)
### Manually
You will need [Node.js][node] installed to run the Atomist CLI. Once
Node.js is installed, you can use `npm` to install the Atomist CLI.
```
$ npm install -g @atomist/cli
```
[node]: https://nodejs.org/ (Node.js)
## Using
To use local software delivery machine (SDM), you will need [Git][git]
installed. See the [Local SDM][sdm-local] documentation for more
information.
To interact with the Atomist API, you will need an Atomist workspace.
See the [Atomist Getting Started Guide][atomist-start] for
instructions on how to get an Atomist workspace and connect it to your
source code repositories, continuous integration, chat platform, etc.
See the [Atomist Developer Guide][atomist-dev] for more complete
instructions on setting up your development environment.
You can run `atomist --help` to see the standard help message. See
the [Atomist developer quick start][atomist-quick-start] for more
information.
[git]: https://git-scm.com/ (Git)
[sdm-local]: https://github.com/atomist/sdm-local#readme (Atomist - Local Software Delivery Machine SDM)
[atomist-start]: https://docs.atomist.com/user/ (Atomist - Getting Started)
[atomist-dev]: https://docs.atomist.com/developer/prerequisites/ (Atomist - Developer Prerequisites)
[atomist-quick-start]: https://docs.atomist.com/quick-start/ (Atomist Developer Quick Start)
### Configuration
You can use the Atomist CLI to configure your local environment to run
[software delivery machines (SDMs)][sdm] and other Atomist API
clients.
```
$ atomist config
```
See the [Atomist developer prerequisites][atomist-dev] for more
information.
[sdm]: https://docs.atomist.com/ (Atomist Documentation)
### Kubernetes
You can use the Atomist CLI to install the Atomist Kubernetes
utilities in your Kubernetes cluster:
```
$ atomist kube --environment=MY_CLUSTER
```
replacing `MY_CLUSTER` with a meaningful name for the Kubernetes
cluster your `kubectl` utility is configured to communicate with. See
the [Atomist Kubernetes documentation][atomist-k8] for more
information.
[atomist-k8]: https://docs.atomist.com/user/kubernetes/ (Atomist Kubernetes)
### Fetch schema
You can fetch the current version of the GraphQL schema for your
Atomist workspace using the following command.
```
$ atomist gql-fetch
```
If you are defining custom types via registering ingestors in an SDM
or other API client, you should download the schema in each of your
SDM/API client projects prior to building them.
## Support
General support questions should be discussed in the `#help`
channel in the [Atomist community Slack workspace][slack].
If you find a problem, please create an [issue][].
[issue]: https://github.com/atomist/cli/issues
## Development
You will need to install [node][] to build and test this project.
[node]: https://nodejs.org/ (Node.js)
### Build and Test
Use the following package scripts to build, test, and perform other
development tasks.
Command | Reason
------- | ------
`npm install` | install project dependencies
`npm run build` | compile, test, lint, and generate docs
`npm start` | start the Atomist CLI
`npm run lint` | run TSLint against the TypeScript
`npm run compile` | compile TypeScript
`npm test` | run tests
`npm run autotest` | run tests every time a file changes
`npm run clean` | remove files generated during the build
### Release
Releases are managed by the [Atomist SDM][atomist-sdm]. Press the
release button in the Atomist dashboard or Slack.
[atomist-sdm]: https://github.com/atomist/atomist-sdm (Atomist Software Delivery Machine)
---
Created by [Atomist][atomist].
Need Help? [Join our Slack workspace][slack].
[atomist]: https://atomist.com/ (Atomist - How Teams Deliver Software)
[slack]: https://join.atomist.com/ (Atomist Community Slack Workspace)