Project Status
Productivityproject-statusProject Status is an Agent Skill for productivity published in the bactopia/bactopia repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Show a live snapshot of the Bactopia project state — component counts, GroovyDoc coverage, nf-test coverage, and structural issues. Use when asked about project state, coverage, what's missing, what's documented, or what needs attention.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/bactopia/bactopia/blob/HEAD/.claude/skills/project-status/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/project-status, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Project Status
Run the status script and interpret the output for the user.
Steps
-
Run
bactopia-statusvia the wrapper script:bash .claude/skills/project-status/scripts/run-bactopia-status.sh --bactopia-path /home/rpetit3/repos/bactopia/bactopia --json -
Parse the JSON output and present a clean, readable summary. Lead with:
- Component counts (modules / subworkflows / workflows)
- GroovyDoc coverage per tier (doc_count vs total)
- Tag coverage per tier — highlight any required tags below 100%
- nf-test coverage (workflows only)
- Any structural issues (missing required files)
-
Highlight the most important gaps — prioritize by:
- Missing required files (module.config, schema.json) first — these are structural breaks
- Missing GroovyDoc second — documentation gaps
- Missing nf-tests last — coverage gaps
-
If the user asks "what should I work on next?", suggest the highest-priority gaps from the output.
Notes
- The wrapper script auto-discovers
bactopia-status(checks PATH, then conda envs) - nf-test coverage is workflows-only — modules and subworkflows are excluded for now
- Report whether the root pipeline test exists (
nftest.root_test)
JSON Output Fields
timestamp— when the report was generatedrepo— path to the Bactopia repositorygit—branch,commit,modifiedfile countcounts—modules,subworkflows,workflowstiers— per-tier detail, each withtotal,doc_count,issues[],tag_coveragetag_coverage— map of tag name to count of components that have it
nftest—total(workflow count),tested,root_test
GroovyDoc Fields
All components use these required tags:
@status—stable,beta, ordeprecated@keywords— comma-separated search terms@tags—complexity:<simple|moderate|complex> input-type:<single|multiple|parameter> output-type:<single|multiple> features:<list>@citation— comma-separated bibtex keys@note— optional caveats or requirements
Modules and subworkflows also use:
@input— input channel descriptions (can be multi-line for records)@output— output channel descriptions (single-line)
Subworkflows additionally use:
@subworkflows— list of included subworkflows (directory keys)@modules— list of included modules (directory keys)
Entry workflows use:
@subworkflows— included subworkflows (directory keys); workflows never call modules directly, so@modulesis not used@input— parameter inputs (e.g.,rundir)@section— groups published outputs@publish— file patterns with descriptions (within sections)@note— can appear at top level or within a section
Required Files per Tier
- Modules:
module.config,schema.json - Subworkflows: none beyond
main.nf - Workflows: none beyond
main.nf