README
¶
torus-cli
A secure, shared workspace for secrets.
Homepage | Documentation | Twitter | Security Disclosure | Code of Conduct | Contribution Guidelines
Installation & signup
Manifold provides binaries of torus-cli for OS X and Linux on amd64.
After installing, create an account with:
torus signup
OS X
- homebrew:
brew install manifoldco/brew/torus - npm:
npm install -g torus-cli - bare zip archives per release version are available on https://get.torus.sh/
Linux
- RPM based distributions: Use the following repository configuration:
$ sudo tee /etc/yum.repos.d/torus.repo <<-'EOF'
[torus]
name=torus-cli repository
baseurl=https://get.torus.sh/rpm/$basearch/
enabled=1
gpgcheck=0
EOF
- DEB based distributions: Use the following repository configuration:
DISTRO=$(lsb_release -i | awk '{print tolower($3)}')
CODENAME=$(lsb_release -c | awk '{print $2}')
sudo tee /etc/apt/sources.list.d/torus.list <<< "deb https://get.torus.sh/$DISTRO/ $CODENAME main"
- npm:
npm install -g torus-cli - bare zip archives per release version are available on https://get.torus.sh/
Security Disclosure
Please follow our security disclosure document found here.
License
Manifold's torus-cli is released under the BSD 3-Clause License.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides the daemon API.
|
Package api provides the daemon API. |
|
Package apitypes defines types shared between the daemon and its api client.
|
Package apitypes defines types shared between the daemon and its api client. |
|
Package base32 implements unpadded base32 encoding, using our chosen alphabet.
|
Package base32 implements unpadded base32 encoding, using our chosen alphabet. |
|
Package base64 provides a byte slice type that marshals into json as a raw (no padding) base64url value.
|
Package base64 provides a byte slice type that marshals into json as a raw (no padding) base64url value. |
|
Package cmd contains all of the Torus cli commands
|
Package cmd contains all of the Torus cli commands |
|
Package config exposes static configuration data, and loaded user preferences.
|
Package config exposes static configuration data, and loaded user preferences. |
|
crypto
Package crypto provides access to secure encryption and signing methods
|
Package crypto provides access to secure encryption and signing methods |
|
ctxutil
Package ctxutil contains utilities for using Contexts.
|
Package ctxutil contains utilities for using Contexts. |
|
db
Package db provides persistent storage and caching of values returned from the registry.
|
Package db provides persistent storage and caching of values returned from the registry. |
|
logic
Package logic exposes the core logic engine used for working with keyrings, keys, claims, teams, memberships, orgs, and other primitive objects core to the cryptography architecture
|
Package logic exposes the core logic engine used for working with keyrings, keys, claims, teams, memberships, orgs, and other primitive objects core to the cryptography architecture |
|
observer
Package observer provides a facility for publishing progress updates and state changes from parts of the daemon, an a SSE http handler for consumers of these events.
|
Package observer provides a facility for publishing progress updates and state changes from parts of the daemon, an a SSE http handler for consumers of these events. |
|
registry
Package registry provides access to the Torus registry REST API.
|
Package registry provides access to the Torus registry REST API. |
|
session
Package session provides in-memory storage of secure session details.
|
Package session provides in-memory storage of secure session details. |
|
Package dirprefs provides directory/project specific preference settings
|
Package dirprefs provides directory/project specific preference settings |
|
Package envelope defines the generic encapsulating format for torus objects.
|
Package envelope defines the generic encapsulating format for torus objects. |
|
Package identity defines the ID format used for uniquely identifying objects in Torus.
|
Package identity defines the ID format used for uniquely identifying objects in Torus. |
|
Package pathexp provides a representation of path expressions; locations of secrets within the org/project/environment/service/identity/instance hierarchy supporting globs and alternation.
|
Package pathexp provides a representation of path expressions; locations of secrets within the org/project/environment/service/identity/instance hierarchy supporting globs and alternation. |
|
Package primitive contains definitions of the primitive types used in ag.
|
Package primitive contains definitions of the primitive types used in ag. |
|
Package promptui provides ui elements for the command line prompt.
|
Package promptui provides ui elements for the command line prompt. |
|
tools
|
|
Click to show internal directories.
Click to hide internal directories.