Comandos do pipeline
Referência de comandos do pipeline do Apothem — o fluxo /plan e o catálogo de comandos de auditoria.
O Apothem traz um pipeline /plan ciente da arquitetura, um pipeline
/research de treze estágios e uma sequência de auditoria de onze comandos —
o que dá a todo projeto um caminho estruturado da prosa bruta até um código de
nível de produção revisado em vários eixos, e de uma ideia bruta até um artigo
revisado por pares e disseminado.
Visão geral do pipeline
flowchart LR
accTitle: Plan pipeline command flow
accDescr: Left-to-right flowchart of the apothem plan pipeline from the spec stage through the generate and review stages, then through a conditional architecture-bearing decision that either runs the design stage or skips directly to the execute stage. The orthogonal audit stage wraps the spec-through-review span as a closed remediation loop, and the re-entrant amend stage revises an existing suite and returns it to review.
A[/plan-spec] --> B[/plan-generate]
B --> C[/plan-review]
AUD[/plan-audit<br/>orthogonal: wraps spec → review] -.->|closed-loop remediation| A
AM[/plan-amend<br/>re-entrant: revises an existing suite] -.->|re-review| C
C --> Q{Architecture-bearing suite?}
Q -->|yes| F[/plan-design<br/>emit _inputs/design.md]
Q -->|no| D[/plan-execute]
F --> D
D --> E[/plan-status]
D --> G[Audit review sequence]
G --> H[Completion milestone]Os estágios de planejamento
O pipeline é distribuído como oito slash commands de primeira classe, um por
estágio — cada um invocável de forma independente como /plan-<stage>. O
orquestrador /plan os conduz de uma missão até uma suíte
executada.
| Estágio | Papel | Posição |
|---|---|---|
| /plan-spec | Forja — da prosa à especificação | Início |
| /plan-generate | Gerador — da especificação à suíte de planejamento | Meio da cadeia |
| /plan-review | Auditor — auditoria forense do plano | Meio da cadeia |
| /plan-design | Arquiteto — _inputs/design.md para suítes que afetam a arquitetura | Portão condicional |
| /plan-execute | Executor — execução de fases | Terminal |
| /plan-status | Relator — status somente leitura | Somente leitura |
| /plan-audit | Guardião — envoltório de ciclo fechado de spec → generate → review | Ortogonal (antes da execução) |
| /plan-amend | Zelador — emenda reentrante de uma suíte existente | Reentrante |
/plan-audit é ortogonal ao fluxo linear, e não um estágio dentro dele. Ele
envolve /plan-spec → /plan-generate → /plan-review como um único ciclo
fechado, executa somente os estágios anteriores que faltam, corrige ativamente
os achados e deixa a suíte pronta para /plan-execute. Ele é distinto da
sequência de revisão de auditoria abaixo, que audita uma base de código
executada, e não uma suíte de planejamento.
/plan-design não é uma cerimônia universal. /plan-review classifica se a
suíte altera superfícies que afetam a arquitetura. Se sim, /plan-design emite
o rastro de design que /plan-execute e /architecture-review consomem. Se
não, a suíte revisada segue diretamente para a execução.
O pipeline de pesquisa
O pipeline de pesquisa é distribuído como treze slash commands de primeira
classe, um por estágio — cada um invocável de forma independente como
/research-<stage>, encadeados por um Portão de Sequência e um Manifesto de
Repasse, sob dez mandatos de rigor (fontes autoritativas, reprodutibilidade,
falseabilidade, integridade das citações, pré-registro, ética / conflitos,
rigor estatístico, ciência aberta / FAIR, conformidade com diretrizes de
relato, fundamentação teórica / impacto).
flowchart LR
accTitle: Research pipeline command flow
accDescr: Left-to-right flowchart of the apothem research pipeline from the ideate stage through spec, theory, sources, synthesis, proposal, study design, experiment, analysis, paper, and peer review to publish and disseminate, with a revision loop from review back to paper.
RI[/research-ideate] --> RS[/research-spec]
RS --> RT[/research-theory]
RT --> RSO[/research-sources]
RSO --> RSY[/research-synthesis]
RSY --> RPR[/research-proposal]
RPR --> RD[/research-design]
RD --> RE[/research-experiment]
RE --> RA[/research-analysis]
RA --> RP[/research-paper]
RP --> RR[/research-review]
RR --> RPU[/research-publish]
RPU --> RDI[/research-disseminate]
RR -.->|revision loop| RP| Estágio | Papel | Posição |
|---|---|---|
| /research-ideate | Formular o problema — questões candidatas a partir de uma semente de domínio | Início |
| /research-spec | Enquadrar a questão — hipóteses falseáveis + escopo | Meio da cadeia |
| /research-theory | Arcabouço conceitual + teoria da mudança | Meio da cadeia |
| /research-sources | Coleta sistemática de fontes com um registro de busca reexecutável | Meio da cadeia |
| /research-synthesis | Mapa do estado da arte + análise de lacunas | Meio da cadeia |
| /research-proposal | Objetivos + viabilidade + contingências + impacto + plano de dados + plano de pré-registro; matriz da chamada do financiador ou resposta de ressubmissão | Meio da cadeia |
| /research-design | Desenho do estudo + pré-registro | Meio da cadeia |
| /research-experiment | Executar + registrar, de forma reproduzível | Meio da cadeia |
| /research-analysis | Resultados + estatística | Meio da cadeia |
| /research-paper | Rascunho de artigo de primeira linha | Meio da cadeia |
| /research-review | Crítica no nível de uma revisão por pares | Meio da cadeia |
| /research-publish | Pacote para o veículo + submissão | Meio da cadeia |
| /research-disseminate | Disseminação + impacto + arquivamento FAIR | Terminal |
O orquestrador de fluxo de trabalho encapsulado /research conduz esses estágios da
questão bruta até o artigo publicado (ele próprio não é um estágio),
verificando a saída de cada estágio de forma independente antes que o estágio
seguinte se apoie nela; --quick executa somente /research-sources +
/research-synthesis, para um relatório com citações em uma única passagem.
Os estágios empíricos (fontes, desenho, experimento, análise) e os estágios de redação (artigo, revisão, publicação, disseminação) recorrem, além disso, a superfícies que operacionalizam o rigor — comparação multimétodo justa, procedência dos comparadores, uma estrutura de programa de experimentos, um plano de utilização de computação, um ciclo autônomo de experimentos opcional (opt-in), um portão de avanço baseado na definição de pronto, cegamento com divulgação em etapas, um registro de busca, alocação de estudo e planejamento de poder, disciplina de análise, contingências do plano, integridade de figuras e planejamento de palestras e pôsteres — que acrescentam detalhe operacional aos dez mandatos sem ampliá-los.
Sequência de revisão de auditoria
O orquestrador de fluxo de trabalho encapsulado /audit varre todas as onze dimensões abaixo em uma única passagem paralela — o análogo, na fortaleza de auditoria, de /plan e /research — e sintetiza um único relatório de achados deduplicado e triado por severidade (somente relatório; a remediação é encaminhada para /elevate). Cada dimensão também pode ser invocada individualmente.
O orquestrador de fluxo de trabalho encapsulado /fortress fecha o ciclo que o /audit relata: ele detecta por meio do /audit, verifica cada achado, corrige cada achado remanescente na superfície que o detém, audita novamente em um ciclo limitado e submete o resultado ao portão /release-readiness — o análogo de blindagem para produção de /plan e /research.
| Comando | Área de qualidade |
|---|---|
| /code-review | Qualidade do código |
| /code-audit | Corpus de código |
| /security-audit | OWASP / ASVS |
| /perf-audit | Desempenho |
| /architecture-review | Arquitetura |
| /ux-review | Experiência do desenvolvedor |
| /a11y-audit | Acessibilidade |
| /docs-review | Documentação |
| /dependency-audit | Dependências |
| /supply-chain-audit | Cadeia de suprimentos |
| /threat-model-audit | Modelo de ameaças |
Todos os comandos
Todos os comandos distribuídos, gerados a partir da definição de cada um sob
src/apothem/commands/. Os comandos sem uma página escrita à mão recebem uma
página gerada a partir da mesma definição.
| Command | Summary |
|---|---|
| /plan | Runs the planning pipeline (spec, generate, review, design) with independent verification, confirming at each hand-off; execute stays a manual step the … |
| /plan-spec | Turns free-form prose, notes or rough requirements into a spec-grade _spec/spec.md that keeps the author's wording and settles open questions by inquiry. |
| /plan-generate | Generates a full plan suite (master plan, progress log, decision notes, per-phase files) from a written spec or raw prose. |
| /plan-review | Reads an existing plan suite line by line for fidelity, consistency, completeness and risk, then applies only the revisions the user approves. |
| /plan-design | Writes the architectural design for a reviewed plan suite at _inputs/design.md: components, interfaces, decisions and diagrams. |
| /plan-execute | Use to implement one phase of a reviewed plan suite: reads the phase file and progress notes, verifies prerequisites and review scorecards, implements each … |
| /plan-amend | Changes an existing plan suite without losing resolved decisions, re-deriving only the affected spec, phases and notes. |
| /plan-audit | Audits a plan suite across spec, generate and review, then fixes findings in a loop without per-revision approval until none remain or the cap is hit. |
| /plan-status | Reports plan-suite progress from its tracking files across tasks, phases and artifacts, read-only. |
| /research | Runs the research pipeline from idea to peer-reviewed paper, verifying each stage hand-off and halting before data collection or publication. |
| /research-ideate | Finds a research question from zero by scanning opportunities, gaps, and invalidated hypotheses, then ranking candidates. |
| /research-spec | Frames a research question or notes into a testable spec: falsifiable hypotheses, inclusion and exclusion scope, success metrics. |
| /research-theory | Builds the conceptual framework for a framed research question: theory of change, constructs with operational definitions and a conceptual-model diagram. |
| /research-sources | Collects and screens the literature for a ratified research spec: deduplication, ranking and extraction with provenance. |
| /research-synthesis | Reconciles collected sources into a state-of-the-art map, a literature matrix and a research-gap statement. |
| /research-proposal | Turns a research gap and theoretical framework into a fundable proposal: SMART aims, feasibility, risk register with contingencies, impact pathway, data … |
| /research-design | Turns a synthesized research gap into testable predictions, a study design and a frozen preregistration. |
| /research-experiment | Runs the preregistered study protocol and records raw data with provenance: experiment log, data, and reproducibility manifest (environment, seed, version … |
| /research-analysis | Runs the preregistered statistical analysis on collected data: effect sizes with confidence intervals, multiple-comparison correction, robustness checks, … |
| /research-paper | Assembles a paper draft from the synthesis, study design, and analysis, with every citation checked to resolve. |
| /research-review | Hostile peer review of a paper, from a research suite or a supplied PDF or text: scores novelty, rigor, reproducibility, ethics; ranks revisions. |
| /research-publish | Builds the venue submission package for a reviewed paper: template formatting, cover letter, data and code availability statement, ethics and conflict … |
| /research-disseminate | Plans post-acceptance dissemination and impact: preprint announcement, FAIR data and code archive, altmetrics tracking, rebuttal loop. |
| /audit | Sweeps a repository across all eleven review dimensions in one multi-agent run and returns one verified, severity-ranked report; it never fixes anything. |
| /a11y-audit | Audits rendered pages of a web surface against WCAG 2.2 AA and reports severity-ranked findings per page, without fixing anything. |
| /architecture-review | Reviews a repository against its design document and layer rules, reporting boundary violations, coupling and wiring gaps as ranked findings. |
| /code-audit | Cross-file forensic audit: hidden coupling, type-hint gaps, coverage holes, dead and duplicate code. |
| /code-review | Reviews source files one at a time for readability, naming, complexity, idiom fit and comment quality, and reports severity-ranked findings without editing. |
| /dependency-audit | Audits direct and transitive dependencies for known vulnerabilities, license conflicts, deprecation and loose pins, ranking findings per dependency. |
| /docs-review | Reviews documentation pages for prose clarity, broken links, code-block tags, citations and public-API coverage, reporting severity-ranked findings per page. |
| /perf-audit | Audits an Apothem installation's per-class budgets (hooks, ecosystem verification, conformity gate, tests, agents, shell, lint) with its benchmark drivers, … |
| /security-audit | Audits a repository's security posture: secrets, injection, unsafe deserialization, path traversal, vulnerable dependencies. |
| /supply-chain-audit | Audits a repository's release pipeline: build provenance, artifact signing, SBOM completeness, pinned CI actions and minimum permissions. |
| /threat-model-audit | Threat-models a repository with STRIDE per element and trust boundaries, classifying actors and rating residual risk. |
| /ux-review | Reviews a repository's developer experience from a first-time user's view: CLI ergonomics, error messages, install flow and docs discoverability. |
| /fortress | Hardens a repository end to end: runs the audit sweep, verifies each finding, remediates survivors through the surgical-guard, secret-rotation and vuln-triage … |
| /elevate | Whole-repository elevation: runs the audit sweep, then critiques naming, structure, storytelling and extensibility, remediates what it finds (deletions are … |
| /eval | Runs one evaluation campaign for a language model or prompt: scores each output over a dataset and reports metrics by category plus regressions against a … |
| /freshify | Use when a repository must be made fresh and release-clean: purges caches and stale artifacts, removes legacy narrative and back-references, normalizes file … |
| /github-deploy-fresh | Use when a GitHub repository needs one clean first release on origin/main: a single v0.1.0 release commit, green workflow cards, a first-version changelog, and … |
| /github-deploy-next | Use to run the next release cycle on a GitHub repository: merge ready pull requests, resolve the issues the release addresses, derive the SemVer bump from … |
| /projectify | Builds the Description, Instruction and knowledge files for a chat-app Project or custom assistant through guided questions, within the platform's context … |
| /release-readiness | Pre-release gate sweep: use before shipping a repository to check lint, format, types, tests, dependency and supply-chain risk, visibility surfaces, changelog … |
| /test-suite | Authors and runs behavior-first tests for a repository, triages failures and reports coverage gaps on critical paths. |
| /workflow | Use to run a non-trivial mission as an independent multi-agent workflow: parallel subagents under named return contracts, refute-by-default verification of … |