Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

scaffy

Status: v0.1 is a publishable skeleton. The CLI is wired up, the Agent class exists, and the project is installable from PyPI. Real coding-assistant behavior (LLM calls, tool use, etc.) is not in this version — the Agent is a deterministic stub. The point of releasing 0.1 is to lock in the distribution name, the package layout, and the release pipeline. Subsequent versions will replace the stub with real agent logic.

scaffy is the console script for the scaffy-cli package: a coding-assistant agent that will eventually live in your terminal. This repository ships the package skeleton only.

Install

pip install scaffy-cli
# or, with uv:
uv tool install scaffy-cli

Usage

$ scaffy --version
scaffy, version 0.1.0

$ scaffy hello
Hello from scaffy v0.1.0!

$ scaffy run "explain this codebase"
[stub:stub] echo: explain this codebase

Subcommands

Command Description
scaffy --version Print the installed version.
scaffy hello Print a friendly banner.
scaffy run PROMPT Send a prompt to the agent. In v0.1 this is a stub.
scaffy run PROMPT --model NAME Same, with a named model.
scaffy run PROMPT --verbose Also log the prompt to stderr.

Environment

  • SCAFFY_LOG — log level for the package logger (DEBUG, INFO, WARNING, ERROR). Defaults to WARNING.

Development

Requirements: uv.

git clone https://github.com/scaffolder/scaffy
cd scaffy
uv sync --all-extras

uv run ruff check .
uv run ruff format --check .
uv run ty check src
uv run pytest -q

Release process

  1. Bump __version__ in src/scaffy/__init__.py.
  2. Tag the commit: git tag vX.Y.Z && git push --tags.
  3. The release.yml workflow builds the sdist + wheel and publishes to PyPI via Trusted Publishing. The pypi GitHub environment requires manual approval, so a pushed tag alone will not ship code.

License

MIT — see LICENSE.

About

Scaffy The vEngineer - CODE FASTER. WORK SMARTER... DEFINITELY NOT HARDER!!! ;P

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages