project-template

Blank project repository template for General SSEC projects.

This includes some default community health files such as as a code of conduct and license file.

Prerequisites

This project uses Pixi for dependency management and task execution. Install Pixi by following the installation instructions.

Getting Started

GitHub Codespaces / Dev Containers

The repository ships a .devcontainer/ configuration. Open it in GitHub Codespaces (or VS Code Dev Containers) to get a container with Pixi and the Claude Code, Codex, Copilot CLI, and OpenCode agent CLIs preinstalled; the Pixi environment is installed and auto-activated on first start.

Installation

Install dependencies:

# Install dependencies (Pixi will automatically create the environment)
pixi install

Onboarding

For first-time setup, use the onboarding environment to configure your development environment:

pixi run -e onboard onboard

This will:

• Install pre-commit hooks in your git repository
• Set up shell completion for ssec-cli
• Run the SSEC onboarding process

Project Structure

This project is organized using Pixi features for modular dependency management:

• pre-commit: Code quality and consistency checks
• gh-cli: GitHub CLI for repository interactions
• onboard: Tools for project onboarding and setup

Available Environments

• default: Standard development environment with pre-commit hooks and GitHub CLI
• onboard: Extended environment including onboarding tools

Development

Using Different Environments

Switch between environments as needed:

# Use default environment
pixi shell

# Use onboard environment
pixi shell -e onboard

Adding Dependencies

Edit pixi.toml to add new dependencies:

[dependencies]
your-package = ">=1.0.0"

Then run:

pixi install

or

Directly add packages (this will edit the pixi toml and install):

pixi add your-package

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests. If you use AI tools while contributing, read the AI Policy first: it covers disclosure, review responsibility, and how to credit AI assistance in commits.

License

This project is licensed under the terms specified in the LICENSE file.