0Pricing
AI Agents · Aula

Criando interfaces de agentes de linha de comando

argparse, click e Typer para lidar com argumentos de agentes na CLI.

Criando interfaces de agentes de linha de comando é uma aula grátis de AI Agents no CoddyKit. Esta é a aula 1 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de AI Agents, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de AI Agents inclui 4 aulas no total.

Por que criar uma CLI para seu agente

Uma interface de linha de comando (CLI) torna seu agente acessível a partir de um terminal, permite usá-lo em scripts e facilita testá-lo sem uma interface web. Muitos agentes de produção são disponibilizados como ferramentas de CLI.

O Python tem três bibliotecas excelentes para criar CLIs: argparse (biblioteca padrão), Typer e Click.

argparse: a opção da biblioteca padrão

argparse já vem integrado ao Python — não é necessária nenhuma instalação. Use ArgumentParser() para definir sua interface, add_argument() para declarar parâmetros e parse_args() para processá-los.

import argparse

def main(argv=None):
    parser = argparse.ArgumentParser(
        description='AI Agent CLI — ask questions and get answers'
    )
    parser.add_argument('--query', type=str, required=True, help='The question to ask the agent')
    parser.add_argument('--model', type=str, default='gpt-4o-mini', help='OpenAI model to use (default: gpt-4o-mini)')
    args = parser.parse_args(argv)

    print(f'Querying agent with: {args.query}')
    print(f'Using model: {args.model}')

if __name__ == '__main__':
    main(['--query', 'What is the weather today?'])

Executando uma CLI com argparse e a ajuda gerada automaticamente

argparse gera automaticamente uma mensagem de ajuda --help a partir das definições dos seus argumentos. Execute python agent_cli.py --help para visualizá-la. Argumentos obrigatórios ausentes geram mensagens de erro úteis automaticamente.

# How users invoke the CLI:
# python agent_cli.py --query 'What is the weather in Paris?'
# python agent_cli.py --query 'Summarize this' --model gpt-4o
# python agent_cli.py --help

# Auto-generated help output:
# usage: agent_cli.py [-h] --query QUERY [--model MODEL]
#
# AI Agent CLI -- ask questions and get answers
#
# options:
#   -h, --help     show this help message and exit
#   --query QUERY  The question to ask the agent
#   --model MODEL  OpenAI model to use (default: gpt-4o-mini)

print('argparse generates help text automatically from your definitions')

Typer: CLI moderno com anotações de tipo

Typer cria CLIs a partir de anotações de tipo do Python — com menos código repetitivo que argparse. Instale com pip install typer. Os parâmetros das funções se tornam automaticamente argumentos da CLI.

# pip install typer
import typer

app = typer.Typer(help='AI Agent CLI')

@app.command()
def ask(
    query: str = typer.Option(..., '--query', '-q', help='Question for the agent'),
    model: str = typer.Option('gpt-4o-mini', '--model', '-m', help='Model to use'),
    verbose: bool = typer.Option(False, '--verbose', '-v', help='Show reasoning steps')
):
    typer.echo(f'Query: {query}')
    typer.echo(f'Model: {model}')
    if verbose:
        typer.echo('Verbose mode enabled')
    # result = run_agent(query, model=model, verbose=verbose)

if __name__ == '__main__':
    app()

Click: estrutura de CLI baseada em decoradores

Click usa decoradores para definir comandos e opções de CLI. Instale com pip install click. Ele oferece recursos avançados, como grupos de comandos, solicitações e barras de progresso.

# pip install click
import click

@click.command()
@click.option('--query', '-q', required=True, help='Question for the agent')
@click.option('--model', '-m', default='gpt-4o-mini', help='LLM model to use')
@click.option('--output', '-o', type=click.Path(), help='Save output to file')
def ask(query: str, model: str, output: str):
    click.echo(f'Sending: {query}')
    # result = run_agent(query, model=model)
    # click.echo(result['answer'])

    if output:
        with open(output, 'w') as f:
            f.write('result["answer"]')
        click.echo(f'Saved to {output}')

if __name__ == '__main__':
    ask()

Adicionando subcomandos

À medida que seu agente cresce, organize as funcionalidades em subcomandos, como agent ask, agent search e agent history. Tanto Click quanto Typer oferecem suporte nativo a grupos de subcomandos.

import typer

app = typer.Typer(help='AI Research Agent')

@app.command()
def ask(query: str = typer.Argument(..., help='Question to ask')):
    'Ask the agent a question'
    typer.echo(f'Asking: {query}')

@app.command()
def search(topic: str = typer.Argument(..., help='Topic to research')):
    'Search and summarize a topic'
    typer.echo(f'Researching: {topic}')

@app.command()
def history(limit: int = typer.Option(10, help='Number of past queries to show')):
    'Show recent query history'
    typer.echo(f'Showing last {limit} queries')

if __name__ == '__main__':
    app()

# Usage: python agent.py ask 'What is AI?'
#        python agent.py search 'Python async'
#        python agent.py history --limit 5

Lendo a entrada padrão em fluxos encadeados

Um agente de CLI que lê da entrada padrão pode ser usado em fluxos encadeados do Unix. Use sys.stdin ou o tipo de argumento stdin do Click para aceitar conteúdo redirecionado.

import sys
import click

@click.command()
@click.argument('input', default='-', type=click.File('r'))
@click.option('--task', default='summarize', help='Task: summarize, translate, or analyze')
def process(input, task: str):
    text = input.read().strip()
    if not text:
        click.echo('Error: no input provided', err=True)
        raise SystemExit(1)

    click.echo(f'Task: {task}')
    click.echo(f'Input length: {len(text)} chars')
    # result = agent.run(task=task, content=text)
    # click.echo(result)

# Usage:
# echo 'Hello world' | python agent_cli.py --task translate
# cat article.txt | python agent_cli.py --task summarize
if __name__ == '__main__':
    process()

Indicadores de progresso para tarefas demoradas

As tarefas do agente podem levar vários segundos. Mostre um indicador giratório ou uma mensagem de progresso para que os usuários saibam que o agente está trabalhando. O Typer oferece suporte integrado a progresso por meio da biblioteca rich.

import typer
from time import sleep

app = typer.Typer()

@app.command()
def research(topic: str = typer.Argument(...)):
    typer.echo(f'Researching: {topic}')

    with typer.progressbar(range(5), label='Gathering sources') as progress:
        for i in progress:
            sleep(0.5)  # simulate work

    typer.echo('Done!')
    typer.echo('Result: [mocked research result]')

# Or with a spinner from rich:
# from rich.console import Console
# console = Console()
# with console.status('Thinking...'):
#     result = agent.run(topic)
# console.print(result)

if __name__ == '__main__':
    app()

Formatação da saída: JSON versus texto simples

Permita que os usuários escolham entre formatos de saída legíveis por humanos e legíveis por máquina. Um sinalizador --json é útil para encaminhar a saída do agente para outras ferramentas.

import json
import typer

app = typer.Typer()

@app.command()
def ask(
    query: str = typer.Argument(...),
    as_json: bool = typer.Option(False, '--json', help='Output as JSON')
):
    result = {
        'query': query,
        'answer': 'Paris is the capital of France.',
        'confidence': 0.98,
        'sources': ['https://wikipedia.org/France']
    }

    if as_json:
        typer.echo(json.dumps(result, indent=2))
    else:
        typer.echo(f'Answer: {result["answer"]}')
        typer.echo(f'Sources: {', '.join(result["sources"])}')

if __name__ == '__main__':
    app()

Tratamento de erros em agentes de CLI

Encerre com um código diferente de zero quando ocorrerem erros, para que os scripts que fazem a chamada possam detectar falhas. Use typer.echo(..., err=True) ou click.echo(..., err=True) para escrever mensagens de erro em stderr.

import sys
import typer

app = typer.Typer()

@app.command()
def ask(query: str = typer.Argument(...)):
    try:
        # result = agent.run(query)
        result = {'status': 'ok', 'answer': 'Result here'}

        if result['status'] != 'ok':
            typer.echo(f'Agent error: {result.get("error")}', err=True)
            raise typer.Exit(code=1)

        typer.echo(result['answer'])

    except Exception as e:
        typer.echo(f'Unexpected error: {e}', err=True)
        raise typer.Exit(code=2)

# Exit codes: 0 = success, 1 = agent error, 2 = unexpected error
# These allow shell scripts to handle failures:
# python agent.py 'query' || echo 'Agent failed'
if __name__ == '__main__':
    app()

Transformando seu agente em uma ferramenta de CLI instalável

Use um ponto de entrada de pyproject.toml para disponibilizar seu agente como um comando do sistema. Depois de executar pip install -e ., os usuários poderão executar myagent ask 'question' diretamente de qualquer diretório.

# pyproject.toml
# [project]
# name = 'myagent'
# version = '0.1.0'
# dependencies = ['typer', 'openai', 'httpx']
#
# [project.scripts]
# myagent = 'myagent.cli:app'

# After pip install -e .:
# myagent ask 'What is AI?'
# myagent search 'Python tutorials'
# myagent --help

# This is how production CLI agents like 'gh', 'poetry', and 'ruff' work
print('Entry points turn your Python module into a system CLI command')

Verificação de conhecimento: interfaces de agentes de CLI

Verifique sua compreensão sobre a criação de interfaces de CLI para agentes.

Recapitulação: criação de interfaces de agentes de CLI

Agora você já consegue criar interfaces de CLI profissionais para seus agentes:

  • Use argparse para CLIs sem dependências (biblioteca padrão)
  • Use typer para CLIs organizadas e orientadas por anotações de tipo
  • Use click para CLIs com muitos recursos e baseadas em decoradores
  • Organize agentes grandes com subcomandos
  • Ofereça suporte à entrada padrão para integração com fluxos encadeados
  • Use sinalizadores --json para obter uma saída legível por máquina
  • Encerre com códigos diferentes de zero quando ocorrerem erros, garantindo compatibilidade com scripts de shell

Perguntas Frequentes

A aula “Criando interfaces de agentes de linha de comando” é grátis?

Sim — o texto completo de “Criando interfaces de agentes de linha de comando” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de AI Agents, atualize para CoddyKit PRO. O curso de AI Agents inclui 4 aulas no total.

O que vou aprender em “Criando interfaces de agentes de linha de comando”?

argparse, click e Typer para lidar com argumentos de agentes na CLI. Você pratica AI Agents com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar AI Agents?

Nenhuma experiência prévia é necessária. AI Agents no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 1 de 4.

Quanto tempo leva a aula “Criando interfaces de agentes de linha de comando”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de AI Agents?

Sim. Cada aula de AI Agents inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Criando interfaces de agentes de linha de comando
  2. Agentes interativos no estilo REPL
  3. Análise de argumentos e texto de ajuda
  4. Transmitindo a saída em agentes de CLI
← Voltar para AI Agents