add-module

Scaffold Bactopia modules from Bioconda packages with standard files and tests.

521|81|Updated Feb 22, 2019
One-click install
npx skills add https://github.com/bactopia/bactopia --skill add-module-bactopia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-module
Source: https://github.com/bactopia/bactopia/tree/main/.claude/skills/add-module
Command: npx skills add https://github.com/bactopia/bactopia --skill add-module-bactopia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffold a complete Bactopia module scaffold from a bioconda/conda-forge package, generating main.nf, module.config, schema.json, and test files to standard project conventions.

Core Features & Use Cases

  • Auto-generates module skeletons for new tools from Bioconda/Conda-forge packages, including GroovyDoc documentation and nf-test templates.
  • Validates structure and documents prerequisites, interactive questioning, and phased workflows to ensure consistent module quality.
  • Use case: When asked to add a new tool/module, run the scaffold to produce ready-to-edit files.

Quick Start

Provide the bioconda/conda-forge package name to scaffold a new Bactopia module.

Frequently Asked Questions about add-module

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new Nextflow module from a bioconda package?

Scaffolding a Bactopia module from a bioconda package requires specifying the package name to auto-generate main.nf, module.config, schema.json, and test files. This ensures new tool modules immediately conform to standard project conventions with valid GroovyDoc and nf-test templates.

What files are generated when scaffolding a Bactopia module?

Scaffolding a Bactopia module generates main.nf, module.config, schema.json, and test files equipped with GroovyDoc and nf-test templates. These files create a complete module skeleton that satisfies standard project requirements for integrating new bioconda tools.

Does the module scaffold include nf-test templates for bioconda tools?

Yes, the module scaffold includes nf-test templates and GroovyDoc documentation for bioconda tools. It validates the structure and documents prerequisites through interactive questioning to ensure consistent module quality across the generated files.

Can I create a conda-forge module skeleton without writing boilerplate code?

Yes, you can create a conda-forge module skeleton without writing boilerplate by running the scaffold with just the package name. It automates generating the required main.nf, configuration, schema, and test files to standard project conventions.

What is the best way to ensure new Bactopia modules meet project conventions?

The best way to ensure new Bactopia modules meet project conventions is to use a scaffolding process that applies phased workflows and validates structure. Auto-generating skeleton files from bioconda or conda-forge packages guarantees consistent module quality and standard formatting.