-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rename init flag
- Loading branch information
Showing
44 changed files
with
877 additions
and
841 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
[package] | ||
name = "ev-cage" | ||
name = "ev-enclave" | ||
version = "0.0.0-dev" | ||
edition = "2021" | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,109 +1,109 @@ | ||
<a href="https://evervault.com/cages"><img src="https://evervault.com/images/logo-color.svg" height="45" /></a> | ||
|
||
# Cages CLI | ||
# Enclave CLI | ||
|
||
Command Line Tool to build, deploy and manage Evervault [Cages](https://github.com/evervault/cages/) | ||
Command Line Tool to build, deploy and manage Evervault [Enclaves](https://github.com/evervault/cages/) | ||
|
||
## Notice on Open Source Status of this project | ||
The Evervault Cages product is open source with the aim of providing transparency to users — this is vital given that our process runs in the enclave, and is accounted for in the attestation. | ||
The Evervault Enclaves product is open source with the aim of providing transparency to users — this is vital given that our process runs in the enclave, and is accounted for in the attestation. | ||
|
||
The current state of this project does not allow for self-hosting. We plan on addressing this by abstracting away the Evervault-specific elements of the Cages product. | ||
The current state of this project does not allow for self-hosting. We plan on addressing this by abstracting away the Evervault-specific elements of the Enclaves product. | ||
|
||
## Subcommands | ||
|
||
### init | ||
|
||
Initialize a Cage.toml in the current directory. Must provide a cage name. | ||
Initialize a enclave.toml in the current directory. Must provide a enclave name. | ||
|
||
`ev-cage init --name my-cage` | ||
`ev-enclave init --name my-enclave` | ||
|
||
### build | ||
|
||
Build a Cage from a Dockerfile. Defaults to use local `cage.toml` file for configuration. See more options with `-h`. | ||
Build an from a Dockerfile. Defaults to use local `cage.toml` file for configuration. See more options with `-h`. | ||
|
||
`ev-cage build` | ||
`ev-enclave build` | ||
|
||
### deploy | ||
|
||
Deploy a Cage from a toml file. Builds a cage from a Dockerfile and then deploys the cage. You can provide a path to an EIF which was already build. See more options with `-h`. | ||
Deploy an Enclave from a toml file. Builds an Enclave from a Dockerfile and then deploys the Enclave. You can provide a path to an EIF which was already build. See more options with `-h`. | ||
|
||
`ev-cage deploy` | ||
`ev-enclave deploy` | ||
|
||
### delete | ||
|
||
Delete a Cage from a toml file. | ||
Delete a Enclave from a toml file. | ||
|
||
`ev-cage delete` | ||
`ev-enclave delete` | ||
|
||
### attest | ||
|
||
Validate the attestation doc provided by a Cage. Defaults to compare against the local `cage.toml` file. | ||
Validate the attestation doc provided by a Enclave. Defaults to compare against the local `enclave.toml` file. | ||
|
||
### env | ||
|
||
Manage Cage environment. Any changes to environment variables require a deployment to take effect. | ||
Manage Enclave environment. Any changes to environment variables require a deployment to take effect. | ||
|
||
#### add | ||
|
||
Add a Cage environment variable. Add `--secret` to encrypt the value. | ||
Add a Enclave environment variable. Add `--secret` to encrypt the value. | ||
|
||
`ev-cage env add --key ENV_VAR_1 --value ENV_VAR` | ||
`ev-enclave env add --key ENV_VAR_1 --value ENV_VAR` | ||
|
||
#### get | ||
|
||
Get Cage environment variables. | ||
Get Enclave environment variables. | ||
|
||
`ev-cage env get` | ||
`ev-enclave env get` | ||
|
||
#### delete | ||
|
||
Delete a Cage environment variable. | ||
Delete a Enclave environment variable. | ||
|
||
`ev-cage env delete --key ENV_VAR_1` | ||
`ev-enclave env delete --key ENV_VAR_1` | ||
|
||
### describe | ||
|
||
Get the PCRs of a built EIF. Defaults to `./enclave.eif` | ||
|
||
`ev-cage describe ` | ||
`ev-enclave describe ` | ||
|
||
### list | ||
|
||
List your Cages and Deployments. | ||
List your Enclave and Deployments. | ||
|
||
#### cages | ||
#### enclave | ||
|
||
List Cages | ||
List Enclaves | ||
|
||
`ev-cage list cages` | ||
`ev-enclave list enclaves` | ||
|
||
#### deployments | ||
|
||
List Deployments of a specific cage. Defaults to the local `./cage.toml` file | ||
List Deployments of a specific enclave. Defaults to the local `./enclave.toml` file | ||
|
||
`ev-cage list deployments` | ||
`ev-enclave list deployments` | ||
|
||
### cert | ||
|
||
Create a new Cage signing certificate | ||
Create a new Enclave signing certificate | ||
|
||
`ev-cage cert new` | ||
`ev-enclave cert new` | ||
|
||
### logs | ||
|
||
Pull the logs for a Cage into. Defaults to the local `./cage.toml` file. | ||
Pull the logs for a Enclave into. Defaults to the local `./enclave.toml` file. | ||
|
||
`ev-cage logs` | ||
`ev-enclave logs` | ||
|
||
### encrypt | ||
|
||
Encrypt a string with the CLI. | ||
|
||
`ev-cage encrypt super-secret-value` | ||
`ev-enclave encrypt super-secret-value` | ||
|
||
### update | ||
|
||
Check for new versions of the CLI and install them. | ||
|
||
`ev-cage update` | ||
`ev-enclave update` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.