Referência de Comandos

Documentação completa de todos os comandos do CriptEnv CLI, organizados por categoria.

Comandos Core

criptenv init

Prepara o diretório ~/.criptenv/ e o banco de metadata local. Este comando é opcional e não cria vault local de secrets nem senha mestra.

bash
criptenv init

criptenv login

Autentica com a conta CriptEnv. Armazena o token de sessão localmente.

ParâmetroTipoDescrição
--emailstringE-mail da conta
bash
criptenv login
criptenv login --email user@example.com

criptenv logout

Encerra a sessão atual e remove o token armazenado localmente.

bash
criptenv logout

criptenv doctor

Verifica a integridade da configuração local: banco de dados, permissões, conectividade e versão do CLI.

bash
criptenv doctor

Segredos

criptenv set

Criptografa e armazena um segredo no vault remoto do projeto. Use a sintaxe KEY=value.

ParâmetroTipoDescrição
KEY=valueobrigatóriostringChave e valor do segredo
--env, -estringAmbiente de destino
--project, -pstringProjeto de destino
bash
criptenv set DATABASE_URL=postgres://user:pass@host/db
criptenv set API_KEY=your_api_key_here -e staging

criptenv get

Descriptografa em memória e exibe o valor de um segredo remoto.

ParâmetroTipoDescrição
KEYobrigatóriostringNome do segredo
--env, -estringAmbiente de origem
--project, -pstringProjeto de origem
--clipboard, -cbooleanCopia o valor para a área de transferência
bash
criptenv get DATABASE_URL
criptenv get API_KEY -e production -c

criptenv list

Lista todas as chaves do vault remoto sem descriptografar valores.

ParâmetroTipoDescrição
--env, -estringFiltrar por ambiente
--project, -pstringFiltrar por projeto
bash
criptenv list
criptenv list -e production

criptenv delete

Remove permanentemente um segredo do vault remoto.

ParâmetroTipoDescrição
KEYobrigatóriostringNome do segredo a remover
--env, -estringAmbiente de origem
--force, -fbooleanPula confirmação
bash
criptenv delete OLD_API_KEY
criptenv delete DB_PASS -e staging -f

criptenv rotate

Cria uma nova versão do segredo. A versão anterior é mantida para referência.

ParâmetroTipoDescrição
KEYobrigatóriostringNome do segredo
--env, -estringAmbiente
--value, -vstringNovo valor (auto-gerado se omitido)
--force, -fbooleanPula confirmação
bash
criptenv rotate API_KEY
criptenv rotate DB_PASS -e production -v newSecurePass123

Sincronização

criptenv push

Importa um arquivo .env para o vault remoto. Sem arquivo, o comando falha com orientação para usar import.

ParâmetroTipoDescrição
FILEobrigatóriostringArquivo .env de origem
--project, -pstringProjeto específico
--env, -estringAmbiente específico
--overwritebooleanSobrescreve chaves existentes
bash
criptenv push .env -p <project-id>
criptenv push .env.production -e production -p <project-id> --overwrite

criptenv pull

Exporta segredos do vault remoto para um arquivo local. Sem --output, o comando falha com orientação para usar export.

ParâmetroTipoDescrição
--project, -pstringProjeto específico
--env, -estringAmbiente específico
--output, -oobrigatóriostringArquivo de saída
--formatstringFormato: env ou json
bash
criptenv pull -p <project-id> --output .env
criptenv pull -e production -p <project-id> -o .env.production

Importação e Exportação

criptenv import

Importa segredos de um arquivo .env para o vault remoto.

ParâmetroTipoDescrição
FILEobrigatóriostringCaminho para o arquivo .env
--env, -estringAmbiente de destino
--project, -pstringProjeto de destino
--overwritebooleanSobrescreve chaves existentes
bash
criptenv import .env
criptenv import .env.production -e production
criptenv import secrets.env --overwrite

criptenv export

Exporta segredos do vault remoto para um arquivo .env ou JSON.

ParâmetroTipoDescrição
--formatstringFormato: env (padrão) ou json
--env, -estringAmbiente de origem
--project, -pstringProjeto de origem
--output, -ostringArquivo de saída (padrão: stdout)
bash
criptenv export
criptenv export --format json -o secrets.json
criptenv export -e production -o .env.production

Ambientes

criptenv env list

Lista todos os ambientes do projeto.

ParâmetroTipoDescrição
--project, -pstringFiltrar por projeto
bash
criptenv env list\ncriptenv env list -p <project-id>

criptenv env create

Cria um novo ambiente.

ParâmetroTipoDescrição
NAMEobrigatóriostringNome do ambiente (ex: staging)
--project, -pstringProjeto ao qual pertence
--display-name, -dstringNome legível para humanos
bash
criptenv env create staging -p <project-id>
criptenv env create production -p <project-id> -d "Production Environment"

Projetos

criptenv projects create

Cria um novo projeto com senha de vault.

ParâmetroTipoDescrição
NAMEobrigatóriostringNome do projeto
--slugstringSlug opcional do projeto
--descriptionstringDescrição do projeto
bash
criptenv projects create meusite
criptenv projects create meusite --description "Backend do MeuSite"

criptenv projects list

Lista todos os projetos.

bash
criptenv projects list

CI/CD

criptenv ci login

Autenticação headless para ambientes de CI/CD.

ParâmetroTipoDescrição
--tokenobrigatóriostringToken de CI/CD (começa com ci_)
--projectstringID do projeto
bash
criptenv ci login --token $CI_TOKEN

criptenv ci logout

Encerra a sessão de CI/CD.

bash
criptenv ci logout

criptenv ci secrets

Lista segredos disponíveis no contexto de CI.

ParâmetroTipoDescrição
--env, -estringAmbiente (padrão: production)
--project, -pstringProjeto
bash
criptenv ci secrets -e production

criptenv ci deploy

Importa um arquivo de secrets para o vault remoto no contexto de CI.

ParâmetroTipoDescrição
--file, -fobrigatóriostringArquivo .env de origem
--env, -estringAmbiente de deploy
--project, -pstringProjeto
bash
CRIPTENV_VAULT_PASSWORD="$VAULT_PASSWORD" criptenv ci deploy --file .env.production -e production -p <project-id>

criptenv ci tokens

Gerencia tokens de CI/CD.

Lista todos os tokens de CI/CD.

bash
criptenv ci tokens list

Integrações

criptenv integrations list

Lista integrações de provedores de nuvem conectadas.

bash
criptenv integrations list

criptenv integrations connect

Conecta um novo provedor de nuvem.

ParâmetroTipoDescrição
PROVIDERobrigatóriostringProvedor: vercel ou render
--tokenstringToken de API do provedor
--namestringNome da integração
bash
criptenv integrations connect vercel
criptenv integrations connect render --token <render-api-key>

criptenv integrations disconnect

Desconecta um provedor de nuvem.

ParâmetroTipoDescrição
PROVIDERobrigatóriostringProvedor a desconectar
bash
criptenv integrations disconnect vercel

criptenv integrations sync

Sincroniza segredos do CriptEnv com o provedor conectado.

ParâmetroTipoDescrição
PROVIDERobrigatóriostringProvedor alvo
--env, -estringAmbiente a sincronizar
--project, -pstringProjeto
bash
criptenv integrations sync vercel -e production
criptenv integrations sync render -e production

Manutenção

criptenv secrets expire

Define a data de expiração de um segredo.

ParâmetroTipoDescrição
KEYobrigatóriostringNome do segredo
--days, -dobrigatóriointDias até expiração
--policystringPolítica: manual, notify (padrão), auto
--env, -estringAmbiente
--project, -pstringProjeto
bash
criptenv secrets expire API_KEY --days 90
criptenv secrets expire DB_PASS --days 30 --policy auto -e production

criptenv secrets alert

Configura alertas de expiração para um segredo.

ParâmetroTipoDescrição
KEYobrigatóriostringNome do segredo
--days, -dobrigatóriointDias antes da expiração para alertar
--env, -estringAmbiente
--project, -pstringProjeto
bash
criptenv secrets alert API_KEY --days 30
criptenv secrets alert DB_PASS --days 14 -e staging

criptenv rotation list

Lista segredos com rotação pendente.

ParâmetroTipoDescrição
--env, -estringFiltrar por ambiente
--project, -pstringFiltrar por projeto
--days, -dintDias à frente para verificar (padrão: 30)
bash
criptenv rotation list
criptenv rotation list --days 7 -e production

criptenv rotation history

Mostra o histórico de rotações de um segredo.

ParâmetroTipoDescrição
KEYobrigatóriostringNome do segredo
--env, -estringAmbiente
--project, -pstringProjeto
bash
criptenv rotation history API_KEY
criptenv rotation history DB_PASS -e staging

Info

Para mais detalhes sobre a configuração do CLI, consulte a página de Configuração.