Skip to main content

☕ koff: AI Project Scaffolder

koff is a fast, lightweight CLI tool designed to instantly scaffold new projects and inject standardized AI-context files like AGENTS.md, .cursorrules, and basic .agents/skills conventions.

Whether you're starting from a local template or cloning a remote GitHub repository, koff streamlines the initialization process and explicitly optimizes your environment for AI coding assistants.

Installation

Using uv (Recommended)

You can install koff globally using uv:

uv tool install koff

(Note: If installing directly from source locally, run uv tool install . inside this project's directory).

Usage

1. Scaffold a New Project

You can instantly scaffold from a GitHub workspace or a local path. koff intelligently understands GitHub shorthand (username/repo) or URLs.

# Scaffold from a GitHub repository into a new folder called my-app
koff fernansd/fastapi-template my-app

# Run without a destination to scaffold in the current directory
koff fernansd/fastapi-template

# You can also use explicit local paths
koff ./templates/my-local-template my-app

2. Inject AI Context into an Existing Project

If you already have a repository and just want to bootstrap the standard AI files (e.g., AGENTS.md, .cursorrules, .agents), run:

koff ai .

This ensures your AI coding assistant (like Cursor or Windsurf) understands the core workflow of your repository.

Development

To build and test koff locally:

# Initialize
uv sync

# Run locally
uv run koff --help

License

MIT

Metadata

Release files for koff 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for koff 0.1.0
File Size Uploaded
koff-0.1.0.tar.gz 6.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for koff 0.1.0
File Interpreter ABI Platform
koff-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.7 kB

Release files / koff-0.1.0.tar.gz

Download URL koff-0.1.0.tar.gz
Size 6.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b651277fbb7a8afb577c5dcff5b7ffe72cf90a698c1aeee279bc5499b687d292
BLAKE2b-256 checksum
How to use checksums
8efbdd4010df4c496b2e9fed6b6fc5e193af25f271cd08f464c92bde7b177250
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / koff-0.1.0-py3-none-any.whl

Download URL koff-0.1.0-py3-none-any.whl
Size 4.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
76ec62e6510bf298cb3fb950f025bd6dabb38635aa36abb195e6061d4c1e59b9
BLAKE2b-256 checksum
How to use checksums
4474e5085b6cdfa5ad9e43b60f4f0b1e516eda6611d001b20a2784d730081e1d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page