CLI

​

Visão Geral

​

Instalação

pip install crewai

​

Uso Básico

crewai [COMMAND] [OPTIONS] [ARGUMENTS]

​

Comandos Disponíveis

​

1. Create

crewai create [OPTIONS] TYPE NAME

• TYPE: Escolha entre “crew” ou “flow”
• NAME: Nome do crew ou flow

crewai create crew my_new_crew
crewai create flow my_new_flow

​

2. Version

crewai version [OPTIONS]

• --tools: (Opcional) Mostra a versão instalada das ferramentas do CrewAI

crewai version
crewai version --tools

​

3. Train

crewai train [OPTIONS]

• -n, --n_iterations INTEGER: Número de iterações para treinar o crew (padrão: 5)
• -f, --filename TEXT: Caminho para um arquivo customizado para treinamento (padrão: “trained_agents_data.pkl”)

crewai train -n 10 -f my_training_data.pkl

# Exemplo de uso programático do comando train
n_iterations = 2
inputs = {"topic": "Treinamento CrewAI"}
filename = "seu_modelo.pkl"

try:
    SuaCrew().crew().train(
      n_iterations=n_iterations,
      inputs=inputs,
      filename=filename
    )
except Exception as e:
    raise Exception(f"Ocorreu um erro ao treinar a crew: {e}")

​

4. Replay

crewai replay [OPTIONS]

• -t, --task_id TEXT: Reexecuta o crew a partir deste task ID, incluindo todas as tarefas subsequentes

crewai replay -t task_123456

​

5. Log-tasks-outputs

crewai log-tasks-outputs

​

6. Reset-memories

crewai reset-memories [OPTIONS]

• -l, --long: Redefine a memória de LONGO PRAZO
• -s, --short: Redefine a memória de CURTO PRAZO
• -e, --entities: Redefine a memória de ENTIDADES
• -k, --kickoff-outputs: Redefine as OUTPUTS DA TAREFA KICKOFF MAIS RECENTE
• -kn, --knowledge: Redefine o armazenamento de CONHECIMENTO
• -akn, --agent-knowledge: Redefine o armazenamento de CONHECIMENTO DOS AGENTES
• -a, --all: Redefine TODAS as memórias

crewai reset-memories --long --short
crewai reset-memories --all

​

7. Test

crewai test [OPTIONS]

• -n, --n_iterations INTEGER: Número de iterações para testar o crew (padrão: 3)
• -m, --model TEXT: Modelo LLM para executar os testes no Crew (padrão: “gpt-4o-mini”)

crewai test -n 5 -m gpt-3.5-turbo

​

8. Run

crewai run

​

9. Chat

crewai chat

@crew
def crew(self) -> Crew:
    return Crew(
        agents=self.agents,
        tasks=self.tasks,
        process=Process.sequential,
        verbose=True,
        chat_llm="gpt-4o",  # LLM para orquestração de chat
    )

​

10. Deploy

• Autenticação: Você precisa estar autenticado para implementar no CrewAI AMP. Você pode fazer login ou criar uma conta com:
  Terminal

  Copy

  Ask AI

  crewai login
  

• Criar um deployment: Depois de autenticado, você pode criar um deployment para seu crew ou flow a partir da raiz do seu projeto local.
  Terminal

  Copy

  Ask AI

  crewai deploy create
  

  • Lê a configuração do seu projeto local.
  • Solicita a confirmação das variáveis de ambiente (como OPENAI_API_KEY, SERPER_API_KEY) encontradas localmente. Elas serão armazenadas de forma segura junto ao deployment na plataforma Enterprise. Verifique se suas chaves sensíveis estão corretamente configuradas localmente (por exemplo, em um arquivo .env) antes de executar este comando.

​

11. Gerenciamento de Organização

crewai org [COMMAND] [OPTIONS]

​

Comandos:

• list: Liste todas as organizações das quais você faz parte

crewai org list

• current: Exibe sua organização ativa atualmente

crewai org current

• switch: Mude para uma organização específica

crewai org switch <organization_id>

• Criar um deployment (continuação):
  • Vincula o deployment ao respectivo repositório remoto do GitHub (normalmente detectado automaticamente).
• Implantar o Crew: Depois de autenticado, você pode implantar seu crew ou flow no CrewAI AMP.
  Terminal

  Copy

  Ask AI

  crewai deploy push
  

  • Inicia o processo de deployment na plataforma CrewAI AMP.
  • Após a iniciação bem-sucedida, será exibida a mensagem Deployment created successfully! juntamente com o Nome do Deployment e um Deployment ID (UUID) único.
• Status do Deployment: Você pode verificar o status do seu deployment com:
  Terminal

  Copy

  Ask AI

  crewai deploy status
  

  Isso retorna o status mais recente do último deployment iniciado (por exemplo, Building Images for Crew, Deploy Enqueued, Online).
• Logs do Deployment: Você pode checar os logs do seu deployment com:
  Terminal

  Copy

  Ask AI

  crewai deploy logs
  

  Isso faz o streaming dos logs do deployment para seu terminal.
• Listar deployments: Você pode listar todos os seus deployments com:
  Terminal

  Copy

  Ask AI

  crewai deploy list
  

  Isto lista todos os seus deployments.
• Deletar um deployment: Você pode deletar um deployment com:
  Terminal

  Copy

  Ask AI

  crewai deploy remove
  

  Isto exclui o deployment da plataforma CrewAI AMP.
• Comando de Ajuda: Você pode obter ajuda sobre o CLI com:
  Terminal

  Copy

  Ask AI

  crewai deploy --help
  

  Isto exibe a mensagem de ajuda para o CLI CrewAI Deploy.

​

11. Chaves de API

​

Provedores iniciais de chave de API

• OpenAI
• Groq
• Anthropic
• Google Gemini
• SambaNova

​

Outras opções

• LiteLLM Providers

​

12. Gerenciamento de Configuração

crewai config [COMANDO] [OPÇÕES]

​

Comandos:

• list: Exibir todos os parâmetros de configuração do CLI

crewai config list

• set: Definir um parâmetro de configuração do CLI

crewai config set <chave> <valor>

• reset: Redefinir todos os parâmetros de configuração do CLI para valores padrão

crewai config reset

​

Parâmetros de Configuração Disponíveis

• enterprise_base_url: URL base da instância CrewAI AMP
• oauth2_provider: Provedor OAuth2 usado para autenticação (ex: workos, okta, auth0)
• oauth2_audience: Valor de audiência OAuth2, tipicamente usado para identificar a API ou recurso de destino
• oauth2_client_id: ID do cliente OAuth2 emitido pelo provedor, usado durante solicitações de autenticação
• oauth2_domain: Domínio do provedor OAuth2 (ex: sua-org.auth0.com) usado para emissão de tokens

​

Exemplos

crewai config list

crewai config set enterprise_base_url https://minha-empresa.crewai.com

crewai config set oauth2_provider auth0

crewai config set oauth2_domain minha-empresa.auth0.com

crewai config reset