> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Helius CLI

> Interface de linha de comando completa para Helius. Mais de 95 comandos para gerenciamento de contas, consultas de blockchain, envio de transações, webhooks, streaming, staking, e mais. Projetado para agentes e automação.

O [Helius CLI](https://www.npmjs.com/package/helius-cli) é uma interface de linha de comando completa para a plataforma Helius. Fornece mais de 95 comandos para gerenciamento de contas, consultas de dados de blockchain, envio de transações, webhooks, streaming em tempo real, staking, ZK Compression, e mais — com saída JSON legível por máquina para todos os comandos.

<Tip>
  **Usando uma ferramenta de IA compatível com MCP?** O [servidor Helius MCP](/docs/pt-BR/agents/mcp) é a maneira recomendada para que agentes de IA interajam com o Helius — ele fornece 10 ferramentas roteadas com entradas/saídas estruturadas, incluindo cadastro de conta embutido. Use o CLI para scripts shell, pipelines CI/CD, ou quando o MCP não estiver disponível.
</Tip>

## Instalação

```bash theme={"system"}
npm install -g helius-cli
```

## Início Rápido — Usuários Existentes

Se você já possui uma chave de API do Helius, basta configurá-la e começar:

```bash theme={"system"}
helius config set-api-key YOUR_API_KEY
```

Obtenha sua chave em [dashboard.helius.dev](https://dashboard.helius.dev). É isso — pule as etapas de cadastro abaixo.

## Início Rápido — Novos Usuários

<Note>
  Todas as invocações `helius signup` requerem `--email`, `--first-name`, e `--last-name` — incluindo o plano Agent.
</Note>

<Steps>
  <Step title="Gerar um par de chaves">
    ```bash theme={"system"}
    helius keygen
    ```

    Saída:

    ```
    ✓ Keypair generated
    Path: ~/.helius/keypair.json
    Address: 7xKp...3nQm

    To use this wallet, fund it with:
      • ~0.001 SOL for transaction fees
      • 1 USDC for Helius signup
    ```

    A dica de financiamento acima só se aplica se você for usar autopay — pule o financiamento se planeja pagar via link hospedado.
  </Step>

  <Step title="Criar conta">
    Dois modos de pagamento: link hospedado (pague de qualquer carteira, nada para financiar) ou autopay (pague USDC a partir do par de chaves local, que deve conter \~0.001 SOL + o valor do plano).

    ```bash theme={"system"}
    # Default: print a hosted payment link, pay with any wallet in the browser
    helius signup --email you@example.com --first-name Jane --last-name Doe

    # After paying via link, finalize the account
    helius signup --resume

    # Or autopay from the local keypair
    helius signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe
    ```
  </Step>

  <Step title="Obtenha suas chaves de API e endpoints">
    ```bash theme={"system"}
    helius projects
    helius apikeys <project-id>
    helius rpc <project-id>
    ```
  </Step>
</Steps>

<Warning>
  Sua chave de API é uma informação sensível que concede acesso à sua conta do Helius. Nunca a exponha em código do lado do cliente, repositórios públicos, ou áreas acessíveis pelo navegador.
</Warning>

## Planos e Preços

Você pode adquirir qualquer plano compartilhado do Helius diretamente pelo CLI. Passe `--plan` durante o cadastro ou use `helius upgrade` mais tarde:

| Plano         | Preço     | Créditos    | Valor `--plan` |
| ------------- | --------- | ----------- | -------------- |
| Agente        | \$1 único | 1,000,000   | `agent`        |
| Desenvolvedor | \$49/mês  | 10,000,000  | `developer`    |
| Empresarial   | \$499/mês | 100,000,000 | `business`     |
| Profissional  | \$999/mês | 200,000,000 | `professional` |

<Note>
  O plano **Agent** (`agent`) é o padrão. Custa \$1 (pago em USDC) para prevenir abuso e fornece 1,000,000 de créditos. Para limites maiores e mais créditos, cadastre-se com um plano pago ou faça upgrade mais tarde.
</Note>

### Cadastro com um plano específico

```bash theme={"system"}
# Default: Agent plan ($1)
helius signup --email you@example.com --first-name Jane --last-name Doe

# Developer plan ($49/mo)
helius signup --plan developer --email you@example.com --first-name Jane --last-name Doe

# Yearly billing (paid plans only)
helius signup --plan business --period yearly --email you@example.com --first-name Jane --last-name Doe
```

### Fazer upgrade de uma conta existente

```bash theme={"system"}
helius upgrade --plan developer --email you@example.com --first-name Jane --last-name Doe
```

### Pagar uma renovação

Quando um período de renovação de assinatura é devido (mensal ou anual), o Helius cria uma **intenção de pagamento** — um pagamento pendente com um ID único, valor e expiração. Você receberá o ID da intenção de pagamento por e-mail ou via [dashboard](https://dashboard.helius.dev).

```bash theme={"system"}
helius pay <payment-intent-id>
```

O comando busca os detalhes da intenção, mostra o valor e a expiração, pede confirmação, então envia o pagamento em USDC da sua carteira keypair.

## Referência de Comandos

O CLI fornece mais de 95 comandos em 14 categorias. Todos os comandos suportam `--json` para saída legível por máquina e substituições globais `--api-key <key>` / `--network <net>`.

<Card title="Referência Completa de Comandos" icon="terminal" href="/docs/pt-BR/agents/cli/commands">
  Todos os mais de 95 comandos — gerenciamento de contas, consultas de blockchain, DAS API, carteira, webhooks, envio de transações, WebSockets, staking, ZK compression, e mais
</Card>

## Modo de Saída JSON

Adicione `--json` a qualquer comando para saída legível por máquina:

```bash theme={"system"}
helius projects --json
helius balance Gh9ZwEm... --json
helius asset owner 86xCnPe... --json
```

Exemplo:

```json theme={"system"}
{
  "projects": [
    {
      "id": "67b9d260-726b-4ba3-8bb0-dbbf794641bf",
      "name": "My Project",
      "plan": "free"
    }
  ]
}
```

## Códigos de Saída

Os agentes devem verificar os códigos de saída para automação confiável:

| Código | Significado                  |
| ------ | ---------------------------- |
| 0      | Sucesso                      |
| 1      | Erro geral                   |
| 10     | Não logado                   |
| 11     | Par de chaves não encontrado |
| 20     | SOL insuficiente             |
| 21     | USDC insuficiente            |
| 30     | Nenhum projeto encontrado    |
| 31     | Projeto não encontrado       |
| 40     | Erro de API                  |

## Configuração

A configuração é armazenada em `~/.helius/`:

```
~/.helius/
├── config.json    # JWT token, API key, network, default project
└── keypair.json   # Solana keypair (if generated with keygen)
```

Gerencie a configuração com:

```bash theme={"system"}
helius config show              # View current config
helius config set-api-key <key> # Set API key
helius config set-network devnet # Switch to devnet
helius config set-project <id>  # Set default project
helius config clear             # Reset everything
```

### Ordem de Resolução da Chave de API

As chaves de API são resolvidas nesta ordem:

1. Flag `--api-key <key>` (substituição por comando)
2. Variável de ambiente `HELIUS_API_KEY`
3. `~/.helius/config.json` (definido via `helius config set-api-key`)

## Opções Globais

Todos os comandos aceitam estas flags:

| Flag                   | Descrição                                                       |
| ---------------------- | --------------------------------------------------------------- |
| `--api-key <key>`      | Sobrescrever a chave de API configurada                         |
| `--network <net>`      | Sobrescrever a rede (`mainnet` ou `devnet`)                     |
| `--json`               | Saída em formato JSON                                           |
| `-k, --keypair <path>` | Caminho para o arquivo keypair (comandos que exigem assinatura) |

## Fluxo Completo do Agente

```bash theme={"system"}
# Step 1: Generate keypair
helius keygen

# Step 2: Create account (default: hosted payment link, pay from any wallet)
helius signup --email you@example.com --first-name Jane --last-name Doe
helius signup --resume   # Finalize after paying via link
# Or autopay from the local keypair (requires ~0.001 SOL + plan USDC):
# helius signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe

# Step 3: Get API keys
helius projects
helius apikeys <project-id>

# Step 4: Get RPC endpoints
helius rpc <project-id>

# Step 5: Start querying
helius balance <address>
helius asset owner <wallet-address>
helius tx history <address> --limit 10
```

## Próximos Passos

<CardGroup cols={2}>
  <Card title="Visão Geral dos Agentes" icon="robot" href="/docs/pt-BR/agents/overview">
    Orientação de API, fluxos de trabalho e tratamento de erros para agentes
  </Card>

  <Card title="Helius MCP" icon="plug" href="/docs/pt-BR/agents/mcp">
    Conecte ferramentas de IA diretamente às APIs Helius
  </Card>

  <Card title="Ver Planos" icon="credit-card" href="/docs/pt-BR/billing/plans">
    Entenda os planos Helius e opções de upgrade
  </Card>

  <Card title="Dashboard" icon="chart-line" href="https://dashboard.helius.dev">
    Monitore o uso da sua API e gerencie chaves
  </Card>
</CardGroup>

## Suporte

<CardGroup cols={2}>
  <Card title="Comunidade no Discord" icon="discord" href="https://discord.com/invite/6GXdee3gBj">
    Junte-se ao nosso Discord para ajuda em tempo real e suporte da comunidade
  </Card>

  <Card title="Suporte por Email" icon="envelope" href="mailto:support@helius.xyz">
    Entre em contato diretamente com nossa equipe de suporte
  </Card>
</CardGroup>