O tamanho certo para cada rotina
Mudanças do Git, arquivos específicos ou o repositório todo. Você escolhe o alcance uma vez e não pensa nisso de novo.
selection = "repository"Documentação de código com IA
Seu padrão definido.
Seu time só roda.
Escolha uma vez o modelo, o idioma, a cobertura e o modo de saída. Depois, doc-code encontra as lacunas, documenta no padrão do projeto e segue o fluxo que você desenhou.
$ doc-code
Generating docs [1/4 doc_code/ai.py:prompt] | model: gemma4:e4b (1/3)...
Applied documentation: doc_code/ai.py:prompt
Generating docs [2/4 doc_code/ai.py:documentation_for] | model: gemma4:e4b (1/3)...
Applied documentation: doc_code/ai.py:documentation_for
Generating docs [3/4 doc_code/scope.py:collect] | model: qwen2.5-coder:14b (1/3)...
Applied documentation: doc_code/scope.py:collect
Documentation applied to 3 file(s).
Configuration: .doc-code.toml · output: apply · confirm: false
Uma vez configuradoO comando diário é só
doc-code.Flexível por escolhaDo símbolo ao repositório, você define o alcance que faz sentido.
Consistente por padrãoFormato, idioma e regras iguais para todo o time.
Configura uma vez.
Padroniza sempre.
Cada projeto pede um nível de autonomia. O doc-code deixa a estratégia explícita no repositório, para que cada execução entregue o resultado esperado sem repetir flags.
Do preview ao apply direto
Use revisão quando ela agrega valor ou aplique automaticamente para transformar documentação em uma etapa natural do fluxo.
output = "apply"A mesma linguagem em todo lugar
Idioma, formato e cobertura vivem no projeto. O resultado fica coerente, independentemente de quem executa.
python_format = "google"Escolha seu
provedor de IA.
Conecte um modelo hospedado quando quiser começar rapidamente ou rode a geração localmente para manter o código no seu ambiente.
Modelos de ponta
Use a API da OpenAI para gerar documentação precisa com o modelo escolhido pelo projeto.
provider = "openai"Uma alternativa direta
Use Gemini com a mesma experiência de configuração e revisão no terminal.
provider = "gemini"Privacidade local
Rode modelos de código localmente, sem credencial e com o código sob seu controle.
provider = "ollama"Um arquivo define
o jeito do time.
Versione um .doc-code.toml junto ao código. Ele transforma preferências dispersas em um padrão compartilhado, reproduzível e simples de usar.
Configuração por repositório
A complexidade fica aqui.
Não no comando.
Modelos, escopo, cobertura, formato e automação ficam declarados no projeto. Para o dia a dia, basta doc-code.
[ai]
provider = "ollama"
models = ["gemma4:e4b", "qwen2.5-coder:14b", "gemma4:12b-mlx"]
endpoint = "http://localhost:11434/api/generate"
max_input_tokens = 3048
context_window_tokens = 16384
max_output_tokens = 512
temperature = 0.1
timeout_seconds = 180
[documentation]
selection = "repository"
coverage = "missing"
request_scope = "symbol"
language = "pt-BR"
python_format = "google"
javascript_format = "jsdoc"
output = "apply"
confirm = false
[limits]
max_files_per_request = 50
max_file_bytes = 1000000
exclude = ["**/node_modules/**", "**/dist/**", "**/build/**", ...]Um comando.
O fluxo que você escolheu.
O projeto decide as regras; o time não precisa lembrá-las. Da execução assistida à automação, a experiência é sempre a mesma: doc-code.
Declare a política do projeto
doc-code config initConfigure uma vez como o projeto seleciona, escreve e aplica documentação.
Compartilhe o padrão
.doc-code.tomlO mesmo arquivo acompanha o repositório e elimina decisões repetidas em cada máquina.
Rode sem pensar em flags
doc-codeA ferramenta faz exatamente o que a configuração do projeto determina.
Início rápido
Configure hoje.
Simplifique todo dia.
Instale, crie o arquivo de configuração e registre nele as preferências do projeto. A partir daí, documentação consistente cabe em um único comando.
# Instale
pip install doc-code
# Crie os padrões do projeto
doc-code config init
# Defina o fluxo do projeto em .doc-code.toml
# No dia a dia
doc-code