Pular para o conteúdo principal

Início rápido

Conecte a sua aplicação e rode ela pela primeira vez com os segredos do time.

:::info Antes de começar Você precisa de uma conta no Envshed (o primeiro acesso cria a conta: Comece grátis) e do Node.js 20.12 ou mais recente. :::

1. Instale o CLI​

terminal
npm install -g envshed

Só quer testar? Rode qualquer comando com npx envshed@latest, sem instalar nada. Veja Instalar o CLI.

Na pasta da sua aplicação, rode:

terminal
cd ~/my-app
npx envshed@latest init

O init entra na sua conta quando precisa e continua depois que você autoriza o dispositivo. Depois ele pergunta passo a passo: a organização e o projeto (reaproveitar ou criar), o ambiente de cada arquivo .env, o ambiente padrão e uma confirmação final. Se você começou pelo painel, copie o comando de init de lá para reaproveitar o que já escolheu.

Se a pasta tem arquivos .env, o init mostra uma tabela com o ambiente de cada um. Mude a linha que quiser e continue. Só aparecem nomes de arquivo e quantidade de segredos, nunca valores, e nada é gravado antes de você confirmar.

O init grava os dados compartilhados em .envshed.json. Os tokens ficam no seu armazenamento pessoal de credenciais. Um monorepo, ou uma pasta com várias aplicações, pode conectar cada aplicação ao seu próprio projeto na mesma configuração. O que já estiver configurado é reaproveitado. Veja init para as opções e para retomar um init interrompido.

3. Prepare os valores e rode​

Adicione os valores no painel, ou importe durante o init os arquivos que você já tem. Projetos que o time já usa vão direto para a execução. Quando termina, o init mostra dicas, entre elas o comando que roda a sua aplicação com as variáveis injetadas. Por exemplo:

terminal
npx envshed@latest run -- npm run dev

Troque o exemplo pelo comando da sua aplicação. O run não precisa de arquivo de ambiente e não cria nenhum. O processo e os filhos dele ainda leem as variáveis injetadas. Sem o arquivo, os valores não ficam no disco, mas esses processos não ficam isolados.

Para deixar isso como padrão, coloque você mesmo o comando envshed run -- no seu script dev, ou rode o init com --wrap-script. O init não muda seus scripts nem seus arquivos .env por conta própria.

4. Escolha outro ambiente​

terminal
npx envshed@latest env staging
npx envshed@latest branch

Isso grava uma escolha pessoal para esta cópia do repositório, fora do git. Os padrões do projeto e os arquivos de ambiente locais não mudam. Para um comando só, use run -e staging. As flags e o ENVSHED_ENV têm prioridade sobre a escolha gravada. Para voltar ao padrão, use env checkout --reset. A CI ignora escolhas pessoais.

Compatibilidade com arquivos, se precisar​

Para ferramentas que exigem arquivos, exporte de forma explícita:

terminal
npx envshed@latest pull

O arquivo tem os valores em texto puro. Revise as perguntas antes de sobrescrever e mantenha o arquivo fora do git. Veja pull e a migração do checkout.

Próximos passos​