Skip to main content

A coding-assistant agent that lives in your terminal.

Project description

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.

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

scaffy_cli-0.1.0.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

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

scaffy_cli-0.1.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file scaffy_cli-0.1.0.tar.gz.

File metadata

  • Download URL: scaffy_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scaffy_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 be13668d947332d1f5ef71d944be2aabea08e42c2789d8c703a077f89712e49d
MD5 3809d06bb6202a1ea6abe652c68646a5
BLAKE2b-256 130fe98b62042b2196d5cdc21582164968afdaaf5e4bbd45ad8b5d621938d56c

See more details on using hashes here.

Provenance

The following attestation bundles were made for scaffy_cli-0.1.0.tar.gz:

Publisher: release.yml on scaffolder/scaffy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scaffy_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: scaffy_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scaffy_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d6a36c829abf1f31e29d098d671e0cfc19437c3d73f2aba2ae999dc711773f8
MD5 0c27c3ad619a74076f1ba589f6de2809
BLAKE2b-256 2592560e54ee42d9ff72628b43aa9f7299381bf3720d0883be0d2072f6cfcfef

See more details on using hashes here.

Provenance

The following attestation bundles were made for scaffy_cli-0.1.0-py3-none-any.whl:

Publisher: release.yml on scaffolder/scaffy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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