https://github.com/cloudfoundry/credhub-cli
CredHub CLI provides a command line interface to interact with CredHub servers
https://github.com/cloudfoundry/credhub-cli
bosh cf-extensions cloudfoundry credential-manager credhub
Last synced: 9 months ago
JSON representation
CredHub CLI provides a command line interface to interact with CredHub servers
- Host: GitHub
- URL: https://github.com/cloudfoundry/credhub-cli
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2016-05-03T18:51:58.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T13:21:28.000Z (almost 2 years ago)
- Last Synced: 2024-04-10T19:03:31.132Z (almost 2 years ago)
- Topics: bosh, cf-extensions, cloudfoundry, credential-manager, credhub
- Language: Go
- Homepage:
- Size: 17.6 MB
- Stars: 38
- Watchers: 30
- Forks: 43
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
[](https://slack.cloudfoundry.org)
[](http://godoc.org/code.cloudfoundry.org/credhub-cli/credhub)
CredHub manages credentials like passwords, certificates, certificate authorities, ssh keys, rsa keys and arbitrary values (strings and JSON blobs). CredHub provides a CLI and API to get, set, generate and securely store such credentials.
* [CredHub Tracker](https://www.pivotaltracker.com/n/projects/1977341)
See additional repos for more info:
* [credhub](https://code.cloudfoundry.org/credhub) : CredHub server code
* [credhub-acceptance-tests](https://github.com/cloudfoundry-incubator/credhub-acceptance-tests) : Integration tests
* [credhub-release](https://github.com/pivotal-cf/credhub-release) : BOSH release of CredHub server
### Installing the CLI
#### Operating system compatibility
The `credhub` CLI is tested on Linux and Mac OS, and is supported on these systems.
It is not tested or supported on Windows, though it has been known to work at some point.
#### MacOS X with Homebrew
```bash
brew install cloudfoundry/tap/credhub-cli
```
#### Linux and Windows
Download and install the desired release from the [release page](https://github.com/cloudfoundry-incubator/credhub-cli/releases).
### Building the CLI:
`make` (first time only to get dependencies, will also run specs)
`make build`
### Go Client
This repository contains a Go client library that can be used independently of the CredHub CLI. Documentation for this library can be found [here](https://godoc.org/code.cloudfoundry.org/credhub-cli/credhub).
### Usage:
CredHub CLI can be used to manage credentials stored in a CredHub server. You must first target the CredHub server using the `api` command. Once targeted, you must login with either user or client credentials. Future commands will be sent to the targeted server. For additional information on how to perform CLI operations, you may review the examples shown [here][1] or review the help menus with the commands `credhub --help` and `credhub --help`.
#### Debug Mode:
To see the API calls made by each CLI command, `export CREDHUB_DEBUG=true`.
[1]:https://docs.cloudfoundry.org/api/credhub/