CLI do Browserbase

Use a CLI oficial do Browserbase para operações na plataforma Browserbase, fluxos de trabalho do Functions e chamadas à API Fetch.

Verificação de configuração

Antes de usar a CLI, verifique se ela está instalada:

which browse || npm install -g browse
browse --help

Para comandos que exigem autenticação, defina a chave da API:

export BROWSERBASE_API_KEY="sua_chave_de_API"

Quando usar essa habilidade

Use essa habilidade quando o usuário quiser:

• executar comandos do Browserbase por meio do browse
• criar esboços, desenvolver, publicar ou chamar funções do Browserbase
• inspecionar ou gerenciar sessões, projetos, contextos ou extensões do Browserbase
• buscar uma página pelo Browserbase sem abrir uma sessão do navegador
• pesquisar na web por meio do Browserbase sem abrir uma sessão do navegador
• navegar ou criar esqueletos de modelos iniciais com o ` browse templates`

Quando não usar essa habilidade

• Para navegação interativa, inspeção de páginas, capturas de tela, cliques, digitação ou fluxos de login, prefira a habilidade “browser ”.
• Para recuperação simples de conteúdo HTTP, em que o usuário não se importa em usar especificamente a CLI, a habilidade “fetch” dedicada costuma ser mais adequada.
• Use os comandos de nível superior do driver (browse open, browse get, browse click, …) apenas quando o usuário desejar explicitamente seguir o caminho da CLI ou já estiver trabalhando em um fluxo de trabalho centrado na navegação.

Seleção de comandos

• funções de navegação para desenvolvimento local, empacotamento, publicação e invocação
• browse cloud sessions, browse cloud projects, browse cloud contexts, browse cloud extensions para recursos da plataforma Browserbase
• `browse cloud fetch ` para solicitações da API Fetch
• navegar na nuvem para pesquisar “ ” para solicitações da API de Pesquisa
• navegar por modelos para visualizar e gerar modelos iniciais
• navegar por“open”, “get”, “click”, etc., para controle direto do navegador local/remoto
• navegar por habilidades de instalação para instalar habilidades do agente Browserbase para o Claude Code

Para trabalhar com o navegador local, use ` browse open --local ` para iniciar um navegador isolado e limpo. Use ` browse open --auto-connect ` somente quando precisar se conectar a uma sessão existente do Chrome que possa ser depurada.

Fluxos de trabalho comuns

Funções

navegar funções init my-function
cd my-function
navegar funções dev index.ts
navegar funções publish index.ts
navegar funções invoke  --params '{"url":"https://example.com"}'

Use ` browse functions invoke --check-status ` para consultar uma invocação existente em vez de criar uma nova.

APIs da plataforma

navegar por projetos na nuvem list
navegar por sessões na nuvem create --proxies --verified --region us-east-1
navegar por sessões na nuvem: criar --solve-captchas --context-id ctx_abc --persist
navegar por sessões na nuvem: obter 
navegar por downloads de sessões na nuvem: obter  --output session-artifacts.zip
navegar por contextos na nuvem criar --body '{"region":"us-west-2"}'
navegar por extensões na nuvem fazer upload de ./my-extension.zip

API Fetch

navegar pelo cloud fetch https://example.com
navegar pelo cloud fetch https://example.com --allow-redirects --output page.html

API de Pesquisa

navegar na nuvem pesquisar "automação de navegador"
navegar na nuvem pesquisar "web scraping" --num-results 5
navegar na nuvem pesquisar "agentes de IA" --output results.json

Modelos

navegar pela lista de modelos
navegar pela lista de modelos --tag Python --source Browserbase
navegar pelos modelos e clonar form-filling --language typescript
navegar pelos modelos e clonar amazon-product-scraping --language python ./my-scraper

Melhores práticas

1. É recomendável consultar a ajuda do `browse` e do `subgroup ` antes de tentar adivinhar os sinalizadores.
2. Use os sinalizadores com traço e maiúsculas/minúsculas exatamente como mostrado na ajuda da CLI.
3. Use `--output ` nos comandos ` browse cloud fetch ` e `browse cloud search ` para salvar os resultados em um arquivo.
4. Use variáveis de ambiente para autenticação, a menos que o usuário queira explicitamente substituições pontuais.
5. Passe corpos de solicitação estruturados com strings JSON em --body ou --params.
6. Lembre-se de que tanto as funções `browse`... quanto `browse cloud`... usam `--base-url ` para substituições da URL base da API.

Solução de problemas

• Chave de API ausente: defina BROWSERBASE_API_KEY ou passe --api-key
• Sinalizador desconhecido: execute novamente o comando relevante com --help e use a forma exata, respeitando maiúsculas e minúsculas
• Comando não encontrado: execute novamente o ` npm install -g browse ` e verifique qual versão do ` browse` está sendo usada

Para obter uma referência comando a comando e mais exemplos, consulte REFERENCE.md.