Helius CLI - Helius Docs

O 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.

Usando uma ferramenta de IA compatível com MCP? O servidor Helius 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.

Instalação

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:

helius config set-api-key YOUR_API_KEY

Obtenha sua chave em dashboard.helius.dev. É isso — pule as etapas de cadastro abaixo.

Início Rápido — Novos Usuários

As invocações de helius signup que criam contas exigem --email, --first-name e --last-name — incluindo o plano Agent. Sua carteira é usada apenas para pagar; ela não substitui seus dados de contato. helius signup --resume, que finaliza um cadastro existente após o pagamento pelo link hospedado, não exige nenhuma outra flag.

Gerar um par de chaves

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
  - USDC for your chosen plan:
      agent          $10 (one-time)
      developer      $49/mo
      business       $499/mo
      professional   $999/mo

Then run: helius signup --email <email> --first-name <name> --last-name <name>
  Options: --plan <plan> --period monthly|yearly --coupon <code> --pay

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

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).

# 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

Obtenha suas chaves de API e endpoints

helius projects
helius apikeys <project-id>
helius rpc <project-id>

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.

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:

Todos os preços exibidos em dólares estão em dólares dos Estados Unidos (USD).

Plano	Preço	Créditos	Valor de `--plan`
Agent	US$ 10, pagamento único	1.000.000	`agent`
Developer	US$ 49/mês	10.000.000	`developer`
Business	US$ 499/mês	100.000.000	`business`
Professional	US$ 999/mês	200.000.000	`professional`

O plano Agent (agent) é o padrão. Ele custa US$ 10 (pagos em USDC) para evitar abusos e oferece 1.000.000 de créditos. Para limites de taxa mais altos e mais créditos, cadastre-se em um plano pago ou faça upgrade depois.

Cadastro com um plano específico

# Default: Agent plan ($10)
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

helius upgrade --plan developer --email you@example.com --first-name Jane --last-name Doe

Pagar uma renovação

Quando chegar a data de renovação de uma assinatura (mensal ou anual), a Helius criará uma intenção de pagamento — um pagamento pendente com ID, valor e data de expiração exclusivos. Você receberá o ID da intenção de pagamento por e-mail ou pelo painel.

helius pay <payment-intent-id>

O comando busca os detalhes da intenção, mostra o valor e a data de expiração, solicita confirmação e, em seguida, envia o pagamento em USDC da carteira do seu par de chaves.

Referência de comandos

A CLI oferece mais de 95 comandos em 14 categorias. Todos os comandos são compatíveis com --json para gerar uma saída legível por máquina e com as substituições globais --api-key <key> / --network <net>.

Full Command Reference

Mais de 95 comandos — gerenciamento de contas, consultas à blockchain, API DAS, carteira, webhooks, envio de transações, WebSockets, staking, compactação ZK e muito mais

Modo de saída JSON

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

helius projects --json
helius balance Gh9ZwEm... --json
helius asset owner 86xCnPe... --json

Exemplo:

{
  "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 garantir uma automação confiável:

Código	Significado
0	Sucesso
1	Erro geral
10	Não autenticado
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:

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:

Sinalizador --api-key <key> (substituição por comando)
Variável de ambiente HELIUS_API_KEY
~/.helius/config.json (definido por meio de helius config set-api-key)

Opções globais

Todos os comandos aceitam estes sinalizadores:

Sinalizador	Descrição
`--api-key <key>`	Substitui a chave de API configurada
`--network <net>`	Substitui a rede (`mainnet` ou `devnet`)
`--json`	Gera a saída no formato JSON
`-k, --keypair <path>`	Caminho para o arquivo do par de chaves (comandos que exigem assinatura)

Fluxo de trabalho completo do agente

# 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óximas etapas

Agents Overview

Orientações sobre a API, fluxos de trabalho e tratamento de erros para agentes

Helius MCP

Conecte ferramentas de IA diretamente às APIs da Helius

View Plans

Conheça os planos da Helius e as opções de upgrade

Dashboard

Monitore o uso da sua API e gerencie as chaves

Suporte

Discord Community

Entre no nosso Discord para obter ajuda em tempo real e suporte da comunidade

Email Support

Entre em contato diretamente com nossa equipe de suporte

​Instalação

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

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

​Planos e Preços

​Cadastro com um plano específico

​Fazer upgrade de uma conta existente

​Pagar uma renovação

​Referência de comandos

Full Command Reference

​Modo de saída JSON

​Códigos de saída

​Configuração

​Ordem de resolução da chave de API

​Opções globais

​Fluxo de trabalho completo do agente

​Próximas etapas

Agents Overview

Helius MCP

View Plans

Dashboard

​Suporte

Discord Community

Email Support

Instalação

Início Rápido — Usuários Existentes

Início Rápido — Novos Usuários

Planos e Preços

Cadastro com um plano específico

Fazer upgrade de uma conta existente

Pagar uma renovação

Referência de comandos

Modo de saída JSON

Códigos de saída

Configuração

Ordem de resolução da chave de API

Opções globais

Fluxo de trabalho completo do agente

Próximas etapas

Suporte