Skip to content

Começar

Requisitos

  • Node.js 20 ou superior

CLI

npx ctxpack                                   # repo inteiro → stdout (markdown)
npx ctxpack . --out context.md                # escrever para ficheiro
npx ctxpack . --budget 100000                 # limitar tokens estimados
npx ctxpack . --format xml --out context.xml  # output XML
npx ctxpack src --ignore "*.snap"             # ignores extra (repetível)
npx ctxpack . --no-redact                     # manter segredos (não recomendado)

Ao escrever para ficheiro, é impresso um resumo no stderr: ficheiros incluídos, tokens estimados, redações e nº de saltados.

Fluxos típicos

  • Perguntar a um modelo sobre o teu repo: npx ctxpack --budget 120000 --out ctx.md e depois anexa ctx.md.
  • Ingestão RAG: gera XML (--format xml) com orçamento de tokens por documento e faz chunking a jusante.
  • Preparar code review: empacota um subdiretório (npx ctxpack src/feature) para focar o modelo.

Biblioteca

import { pack } from 'ctxpack';

const result = pack('.', { budgetTokens: 120_000, format: 'md' });
// result.output, result.includedFiles, result.skippedFiles, result.tokenCount, result.redactions