Securenv

This is a CLI for securenv API where you can upload your env files to a vault and share you your team from a secure way.

Get started

Login

You must be authenticated to get or set any data to secure vault.

$ npx securenv login [username] [password] https://securenv.prod.k8s.inovacao.rdsl.adttemp.com.br

The session will be available for 1h and after the first login you can use an shortcut to login withou pass the api-host.

$ npx securenv login [username] [password]

Security alert

To GET, SET or LIST any information from the vault you have to be logged in and must have all the grants to to the job.

SET an ENV file

$ npx securenv set [project-name] [environment]

So if you want to upload your .env.production file to the vault, you have to do:

$ npx securenv set my-project production

# this will upload .env.production to my-project production vault

GET an ENV file

$ npx securenv get [project-name] [environment]

So if you want to download your .env.production file from the vault, you have to do:

$ npx securenv get my-project production

# this will replace .env.production file with the content of the vault

$ npx securenv get my-project staging

# this will replace .env.staging file with the content of the vault

GET an specific version

When you list list all avaiable projects and environments that you have grants, securenv will show to you up 10 old versions of some environment.

If you want to get an specific version you have to get the versionId you want and do:

$ npx securenv get [project-name] [environment] [version-id]

# this will list all available environments that you have grant

CAT an ENV file

If you only want to see some env file, you can do:

$ npx securenv cat [project-name] [environment]

LIST environments

List all avaiable projects and environments that you have grants.

$ npx securenv list [project-name]

# this will list all available environments that you have grant

SYNC securenv to Azure DevOps Variable Group

This command takes the environment stored in securenv (not the local .env file) and syncs it to an Azure DevOps Variable Group. The Variable Group will match the securenv environment exactly: variables that exist in Azure but not in the env will be removed; variables in the env will be added or updated.

Variable group name: vg-{package-name}-{environment} (e.g. vg-securenv-development).

Before syncing, the CLI shows a disclaimer (variables in the Azure Variable Group will be replaced), a summary (project, environment, variable group name, number of variables), and asks "Tem certeza? (y/n)". The sync only runs if you confirm.

Obrigatório no sync:

• Projeto Azure DevOps: -a ou --azure-project (nome do projeto na Azure onde está o Variable Group).
• PAT: --pat <token> ou variável de ambiente AZURE_DEVOPS_PAT.

Opcional: -o ou --azure-org (org da Azure; padrão: RedeDor-corp).

$ npx securenv@latest sync [environment] -a [azure-project] --pat [seu-token]

Exemplo (org RedeDor-corp é usada por padrão):

$ npx securenv@latest sync development -a MyAzureProject --pat seu-pat

Com outra org:

$ npx securenv@latest sync development -o outra-org -a MyAzureProject --pat seu-pat