Getting Started

Start here if you want to install CADDForge, discover installed tools, and run a first workflow.

Most users interact with CADDForge through the caddforge CLI. Method developers and pipeline authors typically use both the CLI and the Python API.

Basic workflow

1. Install the caddforge bundle, or core and selected plugins in the same Python environment.
2. Use caddforge list-tools to check what the environment can run.
3. Use caddforge show-config <section> <tool> to generate or inspect a config template.
4. Run the workflow with caddforge run <section> <tool> --config config.yaml.
5. Inspect status, logs, and results through the CLI or Python API.

Tutorials and next steps

• First local workflow: analyze supplied synthetic data through CLI and Python.
• First pipeline: select rows using two generic stages.
• GUI walkthrough: inspect the same recorded job in a browser.
• Troubleshooting: diagnose environment, configuration, and execution errors.