Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rancher/cli
Rancher CLI
https://github.com/rancher/cli
Last synced: about 2 months ago
JSON representation
Rancher CLI
- Host: GitHub
- URL: https://github.com/rancher/cli
- Owner: rancher
- License: apache-2.0
- Created: 2016-05-29T16:38:46.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T20:07:12.000Z (3 months ago)
- Last Synced: 2024-10-22T09:11:49.985Z (about 2 months ago)
- Language: Go
- Size: 8.65 MB
- Stars: 350
- Watchers: 41
- Forks: 165
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-rancher - Rancher CLI - The Rancher Command Line Interface (CLI)is a unified tool to manage your Rancher server (Rancher 1.0 / Tools 1.0)
- awesome - cli - Rancher CLI (Go)
README
Rancher CLI
===========
The Rancher Command Line Interface (CLI) is a unified tool for interacting with your Rancher Server.
For usage information see: https://rancher.com/docs/rancher/v2.x/en/cli/
> **Note:** This is for version 2.x.x of the cli, for info on 1.6.x see [here](https://github.com/rancher/cli/tree/v1.6)
## Installing
Check the [releases page](https://github.com/rancher/cli/releases) for direct downloads of the binary. After you download it, you can add it to your `$PATH` or [build your own from source](#building-from-source).
## Setting up Rancher CLI with a Rancher Server
The CLI requires your Rancher Server address, along with [credentials for authentication](https://rancher.com/docs/rancher/v2.x/en/user-settings/api-keys/). Rancher CLI pulls this information from a JSON file, `cli2.json`, which is created the first time you run `rancher login`. By default, the path of this file is `~/.rancher/cli2.json`.
```
$ rancher login https:// -t my-secret-token
```
> **Note:** When entering your ``, include the port that was exposed while you installed Rancher Server.
## Usage
Run `rancher --help` for a list of available commands.
## Building from Source
The binaries will be located in `/bin`.
### Linux Binary
Run `make build`.
### Mac Binary
Run `CROSS=1 make build`.
## Docker Image
Run `docker run --rm -it -v :/root/.rancher/cli2.json rancher/cli2 [ARGS]`.
Pass credentials by replacing `` with your config file for the server.
To build `rancher/cli`, run `make`. To use a custom Docker repository, do `REPO=custom make`, which produces a `custom/cli` image.
## Contact
For bugs, questions, comments, corrections, suggestions, etc., open an issue in
[rancher/rancher](//github.com/rancher/rancher/issues) with a title prefix of `[cli] `.
Or just [click here](//github.com/rancher/rancher/issues/new?title=%5Bcli%5D%20) to create a new issue.
## License
Copyright (c) 2014-2019 [Rancher Labs, Inc.](http://rancher.com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless 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.