# Operações do Digibeectl

Com comandos simples, você pode configurar facilmente seus clientes. As configurações são automaticamente salvas em um arquivo, acelerando os comandos subsequentes.

Siga a tabela para obter a sintaxe padrão e as descrições para executar operações em Digibeectl:

<table data-full-width="true"><thead><tr><th width="135">Operação</th><th>Sintaxe</th><th>Descrição </th></tr></thead><tbody><tr><td>completion</td><td><code>digibeectl completion SUB-COMMAND [flags]</code></td><td>Gera o script de autocompletion para o Digibeectl para o shell especificado.</td></tr><tr><td>config</td><td><code>digibeectl config [flags]</code></td><td>Configura o Digibeectl.</td></tr><tr><td>create</td><td><code>digibeectl create RESOURCE [flags]</code></td><td>Comando para criar recursos. </td></tr><tr><td>delete</td><td><code>digibeectl delete RESOURCE [flags]</code></td><td>Comando para deletar recursos.</td></tr><tr><td>get</td><td><code>digibeectl get RESOURCE [flags]</code></td><td>Obtém todos os recursos ou um recurso específico.</td></tr><tr><td>help</td><td><code>digibeectl get SUB-COMMAND or RESOURCE [flags]</code></td><td>Mostra a documentação de ajuda do Digibeectl. </td></tr><tr><td>info</td><td><code>digibeectl info [flags]</code></td><td>Mostra todos os comandos disponíveis.</td></tr><tr><td>set</td><td><code>digibeectl create RESOURCE [flags]</code></td><td>Define um recurso específico.</td></tr><tr><td>update</td><td><code>digibeectl update [flags]</code></td><td>Atualiza o Digibeectl para a versão mais recente.</td></tr><tr><td>version</td><td><code>digibeectl version [flags]</code></td><td>Mostra as informações de versão do Digibeectl.</td></tr></tbody></table>

Abaixo você pode ver a documentação de ajuda do Digibeectl:

<figure><img src="https://content.gitbook.com/content/cO0A6g1dOsu8BiHYqO67/blobs/ipYnUtMbUlA0Rcilz2Ec/digibeectl_updated.png" alt=""><figcaption></figcaption></figure>

## Tipos de recurso <a href="#h_4a05c14d6c" id="h_4a05c14d6c"></a>

Os tipos de recursos são os recursos específicos a serem acessados ​​e usados ​​para compor determinados comandos.

Confira os exemplos para tipos de recurso:

```
digibeectl [command] <resource> <resource-id> [flags]
digibeectl [command] [resource] [flags]
```

A tabela a seguir inclui uma lista de todos os tipos de recursos suportados:&#x20;

<table data-full-width="true"><thead><tr><th>Operações</th><th width="215">Recurso</th><th>Descrição</th></tr></thead><tbody><tr><td>create, delete, get</td><td>api-mgmt-credentials</td><td>Crie/exclua/obtenha as credenciais de API para a API de Pipeline Metrics.</td></tr><tr><td>create, delete, get</td><td>deployment</td><td>Criar/excluir implantações/Recuperar detalhes de uma implantação específica.</td></tr><tr><td>get</td><td>api-mgmt-url</td><td>Obtenha o URL da API para a API de Pipeline Metrics.</td></tr><tr><td>get</td><td>deployment-history</td><td>Obtenha todo o histórico de implantação.</td></tr><tr><td>get</td><td>license</td><td>Exibe as informações de licença do realm. Usando flags, você pode visualizar os detalhes da licença filtrados por pipeline ou projeto.</td></tr><tr><td>get</td><td>metrics</td><td>Obtém as métricas de um pipeline válido.</td></tr><tr><td>get</td><td>pipeline</td><td>Este comando serve para ler o conteúdo do pipeline.</td></tr><tr><td>get</td><td>project</td><td>Este comando serve para ler os projetos disponíveis.</td></tr><tr><td>get</td><td>realm</td><td>Recursos para consultar informações sobre o seu realm. </td></tr><tr><td>create</td><td>pipeline</td><td>Cria um novo pipeline.</td></tr><tr><td>create</td><td>project</td><td>Cria um novo projeto.</td></tr><tr><td>set</td><td>deployment</td><td>Gerencia operações de implantação.</td></tr></tbody></table>

## Flags de recursos <a href="#h_7477095d7f" id="h_7477095d7f"></a>

As tabelas a seguir categorizam os recursos com base nas operações correspondentes e indicam as **respectivas flags de cada operação**:

### Deployment

<table data-full-width="true"><thead><tr><th width="146">Operação</th><th width="171">Recurso</th><th>Flags</th><th width="139">Título comum</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>get</strong></td><td>deployment</td><td><br></td><td><br></td><td>Lista as implantações.</td></tr><tr><td><br></td><td><br></td><td>--deployment-id</td><td>-d</td><td>Filtra as implantações por ID.</td></tr><tr><td><br></td><td><br></td><td>--environment</td><td>-e</td><td>Filtra as implantações por ambiente (padrão "test").</td></tr><tr><td><br></td><td><br></td><td>--namestring</td><td>-n</td><td>Filtra as implantações por nome.</td></tr><tr><td><br></td><td><br></td><td>--projectName</td><td>-p</td><td>Filtra as implantações por nome do projeto.</td></tr><tr><td><br></td><td><br></td><td>--status</td><td>-s</td><td>Filtra as implantações por status.</td></tr><tr><td><br></td><td><br></td><td>--allspecs</td><td>-a</td><td>Mostra todas as especificações do pipeline (FlowSpec, TriggerSpec, InSpec, OutSpec).</td></tr><tr><td><br></td><td><br></td><td>--flowspec</td><td>-f</td><td>Mostra as especificações Flow do pipeline.</td></tr><tr><td></td><td></td><td>--output</td><td>-o</td><td>Exibe os recursos em formato JSON</td></tr><tr><td><strong>get</strong></td><td>deployment-history</td><td><br></td><td><br></td><td>Lista o histórico das implantações.</td></tr><tr><td><br></td><td><br></td><td>--namestring</td><td>-n</td><td>Filtra o histórico de implantações por nome do pipeline.</td></tr><tr><td><br></td><td><br></td><td>--majorversion</td><td>-m</td><td>Filtra o histórico de implantações pela versão major.</td></tr><tr><td><br></td><td><br></td><td>--page</td><td>-p</td><td>Mostra a quantidade de itens a serem retornados. Padrão é 1.</td></tr><tr><td></td><td></td><td>--output</td><td>-o</td><td>Exibe os recursos em formato JSON.</td></tr><tr><td><br></td><td><br></td><td>--size</td><td>-s</td><td>Mostra a quantidade de páginas para filtrar. Padrão é 20.</td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Exibe ajuda com o histórico de implantações.</td></tr><tr><td><strong>create</strong></td><td>deployment</td><td><br></td><td><br></td><td>Cria uma implantação.</td></tr><tr><td><br></td><td><br></td><td>--pipeline-id</td><td>(mandatory flag)</td><td>ID do pipeline.</td></tr><tr><td><br></td><td><br></td><td>--pipeline-size</td><td>-s</td><td>Tamanho do pipeline. (SMALL/MEDIUM/LARGE). Padrão: SMALL.</td></tr><tr><td><br></td><td><br></td><td>--consumers</td><td>-c</td><td>Número máximo de consumidores no pipeline a ser implantado (Padrão: SMALL=10 / MEDIUM=20 / LARGE=40).</td></tr><tr><td><br></td><td><br></td><td>--environment</td><td>-e</td><td>Ambiente do pipeline para implantação. Padrão: "test".</td></tr><tr><td><br></td><td><br></td><td>--instance-name</td><td>-i</td><td>Nome da instância do pipeline requerido quando o pipeline possui múltiplas instâncias.</td></tr><tr><td><br></td><td><br></td><td>--redeploy</td><td>-</td><td>Ativa o redeploy no pipeline.</td></tr><tr><td><br></td><td><br></td><td>--replicas</td><td>-</td><td>Número de réplicas do pipeline. Padrão: 1</td></tr><tr><td><br></td><td><br></td><td>--wait</td><td>-</td><td>Se ativo, aguarda a conclusão da implantação. Timeout: 300 segundos.</td></tr><tr><td><strong>delete</strong></td><td>deployment</td><td><br></td><td><br></td><td>Remove uma implantação</td></tr><tr><td><br></td><td><br></td><td>--deployment-id</td><td>-d</td><td>ID da implantação a ser removida. </td></tr><tr><td><br></td><td><br></td><td>--environment</td><td>-e</td><td>Ambiente da implantação a ser removido</td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Lista os comandos de ajuda para implementação.</td></tr><tr><td><strong>set</strong></td><td>deployment</td><td></td><td></td><td>Gerencia operações de implantação.</td></tr><tr><td></td><td></td><td><p>--rollback</p><p>--id<br></p><p>(devem ser usadas juntas)</p></td><td></td><td>Executa rollback para restaurar a versão anterior do pipeline que foi implantada. </td></tr><tr><td></td><td></td><td>--restore<br>--history-id</td><td></td><td>Cria uma nova implantação usando o ID de uma versão implantada anteriormente.</td></tr></tbody></table>

### License <a href="#metrics" id="metrics"></a>

<table data-full-width="true"><thead><tr><th>Operação</th><th>Recurso</th><th width="144">Flags</th><th>Atalho</th><th>Descrição</th><th>Permissões</th></tr></thead><tbody><tr><td>get</td><td>license</td><td>--by-project<br>--by-pipeline</td><td></td><td>Exiba as informações de licença do realm. Usando flags, você pode visualizar os detalhes da licença filtrados por pipeline ou projeto.</td><td></td></tr></tbody></table>

### Metrics <a href="#metrics" id="metrics"></a>

<table data-full-width="true"><thead><tr><th>Operação</th><th>Recurso</th><th>Flags</th><th>Atalho</th><th>Descrição</th><th>Permissão</th></tr></thead><tbody><tr><td><strong>get</strong></td><td>metrics</td><td><p>--pipeline-name</p><p>--pipeline-version</p><p>--from</p><p>--to</p><p>--relative-date</p></td><td></td><td><p>Obtém as métricas de um pipeline válido. </p><p><br></p><p>Use as flags --from e --to para filtrar métricas de uma data ou intervalo específico. A flag --from pode ser usada sem a flag --to, mas a flag  --to não pode ser usada sozinha.</p><p><br></p><p>A flag --relative-date é outra opção que permite filtrar métricas dentro de intervalos de tempo relativos. Você pode usar valores como: últimos 5 minutos, últimos 3 dias, últimos 7 dias ou especificar um intervalo de datas.</p><p><br></p></td><td></td></tr></tbody></table>

### Permissões

<table data-full-width="true"><thead><tr><th>Operação</th><th>Recurso</th><th>Flags</th><th>Atalho</th><th>Descrição</th><th>Permissões</th></tr></thead><tbody><tr><td><strong>get</strong></td><td>users</td><td><br></td><td><br></td><td>Exibe usuários</td><td><br></td></tr><tr><td><br></td><td><br></td><td><p>--archived</p><p><br><br></p></td><td>-a </td><td><p>Exibe usuários arquivados</p><p><br></p></td><td><br></td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Exibe ajuda sobre usuários</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--output</td><td>-o </td><td>Retorna dados no formato JSON em vez de dados formatados.</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--page int</td><td>-p</td><td>Número de páginas (Padrão: 1) </td><td><br></td></tr><tr><td><br></td><td><br></td><td>--search string</td><td>-s</td><td>Buscar usuários</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--size int</td><td><br></td><td>Itens por página (Padrão: 10)</td><td><br></td></tr><tr><td><strong>get</strong></td><td>user-permissions</td><td><br></td><td><br></td><td>Exibir permissões do usuário</td><td><br></td></tr><tr><td><br></td><td><br></td><td><p>--archived</p><p><br><br></p></td><td>-a </td><td><p>Exibe usuários arquivados</p><p><br></p></td><td><br></td></tr><tr><td><br></td><td><br></td><td>--email string</td><td>-e</td><td>Exibe email do usuário</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--help </td><td>-h</td><td>Exibe ajuda sobre usuários</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--list</td><td>-l</td><td>Exibir informações em formato de lista</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--output</td><td>-o</td><td>Retorna dados no formato JSON em vez de dados formatados.</td><td><br></td></tr></tbody></table>

### Pipeline

<table data-full-width="true"><thead><tr><th width="140">Operação</th><th>Recurso</th><th>Flags</th><th width="134">Título comum</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>get</strong></td><td>pipeline</td><td><br></td><td><br></td><td>Lista os pipelines</td></tr><tr><td><br></td><td><br></td><td>--allspecs</td><td><br></td><td>Mostra todas as especificações do pipeline (FlowSpec, TriggerSpec, InSpec, OutSpec). Requerido: --pipeline-id</td></tr><tr><td><br></td><td><br></td><td>--flowspec</td><td>-o</td><td>Mostra o FlowSpec do pipeline.<br>Requerido: --pipeline-id</td></tr><tr><td><br></td><td><br></td><td>--archived</td><td>-a</td><td>Mostra apenas pipelines arquivados.</td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Exibe ajuda para o pipeline</td></tr><tr><td><br></td><td><br></td><td>--name string</td><td>-n</td><td>Filtra os pipelines por nome</td></tr><tr><td><br></td><td><br></td><td>--page int</td><td><br></td><td>Página de resultados (padrão 1)</td></tr><tr><td><br></td><td><br></td><td>--pipeline-id string</td><td><br></td><td>Filtra os pipelines por ID</td></tr><tr><td><br></td><td><br></td><td>--pipeline-version-major string</td><td><br></td><td>Filtra os pipelines por versão major</td></tr><tr><td><br></td><td><br></td><td>--pipeline-version-minor string</td><td><br></td><td>Filtra os pipelines por versão minor</td></tr><tr><td><br></td><td><br></td><td>--project-id string</td><td><br></td><td>Filtra os pipelines por ID do projeto</td></tr><tr><td><br></td><td><br></td><td>--show-versions</td><td><br></td><td>Mostra os pipelines que possuem versões</td></tr><tr><td></td><td></td><td>--output</td><td>-o</td><td>Exibe os recursos em formato JSON</td></tr><tr><td>create</td><td>pipeline</td><td><p>--name string</p><p>--description<br>--project string</p><p>(flags obrigatórias)</p><p>--help</p><p></p></td><td><p>-n</p><p>-d<br>-p</p><p>-h</p><p><br></p></td><td>Cria um novo pipeline. </td></tr></tbody></table>

### Project <a href="#project" id="project"></a>

<table data-full-width="true"><thead><tr><th>Operation</th><th>Resource</th><th>Flags</th><th>Shorthand</th><th>Description</th><th>Permissions</th></tr></thead><tbody><tr><td>create</td><td>project</td><td><p>--name</p><p>--description</p><p>(flags obrigatórias)</p><p>--help</p></td><td><p>-n</p><p>-d</p><p>-h</p></td><td>Cria um novo projeto. </td><td><br></td></tr></tbody></table>

### **Realm**

<table data-full-width="true"><thead><tr><th>Operação</th><th width="131">Recurso</th><th width="112">Flags</th><th width="139">Título comum</th><th width="130">Descrição</th><th>Permissões</th></tr></thead><tbody><tr><td><strong>get</strong></td><td>realm</td><td><br></td><td><br></td><td>Lista informações do realm</td><td>REALM:READ</td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Lista os comandos de ajuda</td><td><br></td></tr><tr><td></td><td></td><td>--output</td><td>-o</td><td>Exibe os recursos em formato JSON</td><td></td></tr></tbody></table>

### Gerenciamento de API&#x20;

<table data-full-width="true"><thead><tr><th>Operação</th><th width="200">Recurso</th><th width="122">Flags</th><th>Título comum</th><th width="149">Descrição</th><th>Permissões</th></tr></thead><tbody><tr><td><strong>get</strong></td><td>api-mgmt-credentials</td><td><br></td><td><br></td><td>Gerencia as credenciais de API para a API de Pipeline Metrics.</td><td>METRICS:READ</td></tr><tr><td><br></td><td><br></td><td>--username</td><td>-u</td><td>Pesquisar por nome de usuário (opcional)</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Obter ajuda com os comandos. </td><td><br></td></tr><tr><td><strong>get</strong></td><td>api-mgmt-url</td><td><br></td><td><br></td><td>Obtenha o URL da API para a API de Pipeline Metrics.<br></td><td><br></td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Obtém ajuda com os comandos</td><td><br></td></tr><tr><td><strong>create</strong></td><td>api-mgmt-credentials</td><td><br></td><td><br></td><td>Cria as credenciais de API para a API de Pipeline Metrics.<br></td><td><br></td></tr><tr><td><br></td><td><br></td><td>--username</td><td>-u</td><td>Nome de usuário para credenciais de API (obrigatório)</td><td><br></td></tr><tr><td><br></td><td><br></td><td>--password</td><td>-p</td><td>Senha para credenciais de API (obrigatório)</td><td><br></td></tr><tr><td><strong>delete</strong></td><td>api-mgmt-credentials</td><td>--username</td><td>-u</td><td>Excluir um nome de usuário.</td><td><br></td></tr></tbody></table>

{% hint style="info" %}
Para que o nome de usuário seja excluído, o nome do realm deve ser incluído antes do nome de usuário.
{% endhint %}

### Gerenciamento de informações

### Configurações

<table data-full-width="true"><thead><tr><th>Operação</th><th>Subcomando</th><th width="219">Flags</th><th width="137">Título comum</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>config</strong></td><td>set</td><td><br></td><td><br></td><td>Definir uma nova configuração com parâmetros de autenticação.</td></tr><tr><td><br></td><td><br></td><td>--file (mandatory)</td><td>-f</td><td>Gerar um arquivo de configuração.</td></tr><tr><td><br></td><td><br></td><td>--secret-key (mandatory)</td><td>-s</td><td>A chave criptografada.</td></tr><tr><td><br></td><td><br></td><td>--auth-key (mandatory)</td><td>-a</td><td>A chave de autenticação.</td></tr><tr><td></td><td></td><td>--auth-id (optional)</td><td></td><td>Se uma conta não for fornecida, o valor da flag será exibida como account-X, onde X é um inteiro sequencial exclusivo começando em 0.</td></tr><tr><td><strong>config</strong></td><td>get</td><td><br></td><td><br></td><td>Obtêm os detalhes da configuração do realm. O padrão é o realm atual.</td></tr><tr><td></td><td></td><td>--auth-id</td><td></td><td>Obtêm as configurações dos realms ao pesquisar por <code>--auth-id</code>.</td></tr><tr><td><br></td><td><br></td><td>--help</td><td>-h</td><td>Lista os comandos de ajuda.</td></tr><tr><td><strong>config</strong></td><td>view</td><td><br></td><td><br></td><td>Lista todos os realms/contas disponíveis e suas configurações</td></tr><tr><td><strong>config</strong></td><td>list</td><td><br></td><td><br></td><td>Lista todos os realms/contas disponíveis e suas configurações</td></tr><tr><td><strong>config</strong></td><td>use</td><td></td><td><br></td><td><p>Este comando permite que o usuário altere o realm atual ou a conta atual no digibeectl.</p><p></p><p>Para usá-lo, você deve especificar uma das seguintes flags: <code>--realm</code> ou <code>--auth-id.</code><br></p><p>Essas flags são mutuamente exclusivas, o que significa que apenas uma delas pode ser usada por vez.</p></td></tr><tr><td><br></td><td><br></td><td>--realm</td><td>-r</td><td>O usuário pode alterar o realm atual para qualquer um dos realms disponíveis.</td></tr><tr><td></td><td></td><td>--auth-id</td><td></td><td>O usuário pode alternar entre as contas configuradas.</td></tr><tr><td><strong>config</strong></td><td>delete</td><td></td><td><br></td><td>Excluir uma configuração Digibeectl de um realm.</td></tr><tr><td></td><td></td><td>--auth-id </td><td></td><td>Use <code>--auth-id</code> para excluir uma configuração através do digibeectl.</td></tr><tr><td><strong>config</strong></td><td>update</td><td></td><td><br></td><td>Atualiza o Digibeectl para a versão LTS (Long-term support).</td></tr><tr><td><strong>config</strong></td><td>update-context</td><td></td><td></td><td>O usuário recebe uma atualização dos realms disponíveis para contas com status ativo no digibeectl.</td></tr><tr><td><strong>config</strong> </td><td>version</td><td></td><td><br></td><td>Exibir a versão atual do Digibeectl.</td></tr></tbody></table>