Initial project setup for small-scripts
Spec-driven utility script collection with dryrun support and automated testing. Includes project docs, test runner, and directory structure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
33
README.md
Normal file
33
README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# small-scripts
|
||||
|
||||
A collection of small, standalone utility scripts for daily use. Scripts are symlinked into `~/sbin` for PATH availability.
|
||||
|
||||
## Approach
|
||||
|
||||
This project uses **spec-driven development** (OpenSpec) as a testbed for agent-driven development and refinement:
|
||||
|
||||
1. Every script starts with a spec in `specs/`
|
||||
2. Every script supports `--dryrun` to preview actions without side effects
|
||||
3. Every script has a test in `tests/` that validates dryrun behaviour against the spec
|
||||
|
||||
## Scripts
|
||||
|
||||
| Script | Purpose | Status |
|
||||
|--------|---------|--------|
|
||||
| *(none yet)* | | |
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
./tests/run-all.sh
|
||||
|
||||
# Symlink a script into ~/sbin
|
||||
ln -sf "$(pwd)/scripts/<name>" ~/sbin/<name>
|
||||
```
|
||||
|
||||
## Milestones
|
||||
|
||||
| # | Description | Status |
|
||||
|---|-------------|--------|
|
||||
| M1 | Project setup, first script | In progress |
|
||||
Reference in New Issue
Block a user