# Comece a usar

Esta documentação apresenta os passos que devem ser executados para que o Digibeectl seja instalado e funcione corretamente.

## Baixe o arquivo de configuração

Siga as etapas abaixo para obter o arquivo de configuração: 

1. Faça login na Digibee Integration Platform.
2. Clique no botão **Administração**. 
3. Clique em **Digibeectl** no menu do lado esquerdo da tela.
4. Clique no botão **Criar**.
5. Dê um título ao seu token. 
6. Insira uma lista de permissões a serem concedidas a este token.
7. Defina um período de expiração para o seu token. O período varia de 1 hora a 1 ano.
8. Salve sua lista de permissões e período de expiração.
9. Copie a chave de criptografia gerada pela Plataforma usando o ícone de copiar e salve a chave para uso posterior. Em seguida, crie a senha do arquivo.
10. Salve a senha e baixe o arquivo.

## Execute a instalação

O digibeectl é fornecido como um arquivo ‘tar.gz’ para MacOs e Linux. 

{% hint style="warning" %}
Embora o Windows não ofereça suporte nativo, ele pode ser instalado configurando o WSL (Windows Subsystem for Linux), permitindo que a ferramenta seja instalada e configurada em um ambiente Linux dentro do Windows. Consulte a [documentação](/documentation/developer-guide/pt-br/development-cycle/digibeectl/getting-started/windows-install.md) para saber como instalar o Digibeectl no Windows.
{% endhint %}

1. Para instalar o arquivo, abra uma janela de terminal e execute a linha de comando abaixo:

<pre class="language-bash"><code class="lang-bash"><strong>curl -s https://storage.googleapis.com/digibee-release-test/releases/install.sh | bash
</strong></code></pre>

2. Use a linha de comando abaixo após instalar o Digibeectl. Substitua as palavras “`path/file.json`” pelo endereço do arquivo de configuração e as palavras "`encryption key`" e "`encryption passphrase`" pelos dados que você definiu antes:

```bash
digibeectl config set --file "path/file.json" --secret-key "encryption-key" --auth-key "encryption-passphrase"
```

### Personalizando o diretório de configuração

Por padrão, o Digibeectl armazena seus arquivos de configuração no diretório `~/.digibeectl/`. No entanto, você pode personalizar essa localização definindo a variável de ambiente `DIGIBEECTL_PATH`. Utilize os seguintes comandos para especificar o diretório desejado:

* **Sistemas baseados em Unix (Linux, macOS):** Execute o comando no terminal ou adicione-o ao seu arquivo de configuração do shell.

```
export DIGIBEECTL_PATH=/custom/path/to/config/directory
```

* **Windows:** Execute o comando no terminal ou siga [este tutorial](https://phoenixnap.com/kb/windows-set-environment-variable) para configurar através da interface.

```
set DIGIBEECTL_PATH=/custom/path/to/config/directory
```

{% hint style="info" %}
Certifique-se de que o diretório especificado exista e que você tenha as permissões adequadas de read/write. Se o caminho não terminar com uma barra (`/`), ela será adicionada automaticamente.
{% endhint %}

## **Baixe as atualizações** <a href="#h_f50d8e548b" id="h_f50d8e548b"></a>

Para atualizar o Digibeectl, execute a linha de instalação novamente. Para fazer isso, abra uma janela de terminal e digite:

```bash
curl -s https://storage.googleapis.com/digibee-release-test/releases/install.sh | bash
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digibee.com/documentation/developer-guide/pt-br/development-cycle/digibeectl/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.