Skip to main content

Vigil CLI: Observable, collaborative, reproducible science platform

Project description

Vigil CLI

Observable, collaborative, reproducible science platform.

Installation

Base Installation

# Install core CLI with uv
uv tool install cofactor-vigil

# Or with pip
pip install cofactor-vigil

The base installation includes only the core CLI commands (new, dev, build, run, promote, anchor, doctor, etc.).

MCP Server Installation

To use the MCP server (vigil mcp serve), install with the mcp extras:

# Install with MCP server support
uv tool install "cofactor-vigil[mcp]"

# Or with pip
pip install "cofactor-vigil[mcp]"

The mcp extras include:

  • mcp>=1.1.0 - MCP protocol server
  • polars>=0.20.0 - Fast data frame library for data previews

Quick Start

# Create a new project from a template
vigil new imaging-starter my-project
cd my-project

# Install dependencies
uv sync

# Preview the pipeline (dry-run)
vigil dev

# Execute the pipeline
vigil run --cores 4

# Promote artifacts to receipts
vigil promote

# Anchor receipts with Merkle proofs
vigil anchor

Commands

Project Management

  • vigil new <template> [path] - Create a new project from a template
  • vigil new --list - List available templates

Development

  • vigil dev - Dry-run the pipeline and preview the DAG
  • vigil build - Execute the pipeline without promotion
  • vigil run - Execute targets and optionally promote
  • vigil conformance - Check outputs against golden baselines

Receipt Management

  • vigil promote - Generate Vigil receipts from artifacts
  • vigil anchor - Create Merkle anchors for receipts
  • vigil url - Print the vigil:// URL for the project

Health & Maintenance

  • vigil doctor - Run repository health checks
  • vigil spec sync - Sync workspace.spec.json with vigil.yaml
  • vigil spec --dry-run - Preview workspace spec changes

Workbench & AI

  • vigil ui bootstrap - Generate Workbench configuration
  • vigil mcp serve - Start the MCP server for assistants
  • vigil ai propose - Generate auto-target suggestions
  • vigil ai apply - Execute auto-target proposal

Templates

Available starter templates:

  • imaging-starter: Full-featured imaging pipeline with sciencecast timeline
  • minimal-starter: Smallest viable template for getting started

Documentation

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cofactor_vigil-0.1.4.tar.gz (157.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cofactor_vigil-0.1.4-py3-none-any.whl (165.9 kB view details)

Uploaded Python 3

File details

Details for the file cofactor_vigil-0.1.4.tar.gz.

File metadata

  • Download URL: cofactor_vigil-0.1.4.tar.gz
  • Upload date:
  • Size: 157.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.10

File hashes

Hashes for cofactor_vigil-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3ef613d19c26b34035d8a74d09316190512963e8103327581220b3f2a422e034
MD5 81a051d16efe1b4d6de2b0944ab0b0f8
BLAKE2b-256 a78701c3962c945f107fe1ca3f3a8ed1b72fc90102e363305bd4b89aa3d30876

See more details on using hashes here.

File details

Details for the file cofactor_vigil-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for cofactor_vigil-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9659b08c3bc182ea3d0c69c10c2aca49d8d4ef6aad60c4bb47f8e37a462ab1c3
MD5 b83e4ea0acadcb8d8fb2b37030db7ec9
BLAKE2b-256 a87989fa8e7c70b5037d33eac2ddf7eba4646e034b7d4c354fccf4b3f5e3d85a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page