Files
TSYSDevStack/ToolboxStack/README.md
ReachableCEO ab57e3a3a1 feat: Update toolbox-base and template with latest Docker configurations and documentation
\n- Updated Dockerfiles in both toolbox-base and toolbox-template
- Modified build scripts and docker-compose configurations
- Added new audit tools and documentation files
- Created new toolbox-DocStack and toolbox-QADocker implementations
- Updated README and maintenance documentation
2025-10-31 12:46:36 -05:00

54 lines
3.0 KiB
Markdown

# 🧰 ToolboxStack
ToolboxStack provides reproducible developer workspaces for TSYSDevStack contributors. The current `toolbox-base` image captures the daily-driver container environment used across the project.
---
## Contents
| Area | Description | Path |
|------|-------------|------|
| Dev Container Image | Ubuntu 24.04 base with shell tooling, mise, aqua-managed CLIs, and Docker socket access. | [`output/toolbox-base/Dockerfile`](output/toolbox-base/Dockerfile) |
| Build Helpers | Wrapper scripts for building (`build.sh`) and running (`run.sh`) the Compose service. | [`output/toolbox-base/`](output/toolbox-base) |
| Devcontainer Config | VS Code Remote Container definition referencing the Compose service. | [`output/toolbox-base/.devcontainer/devcontainer.json`](output/toolbox-base/.devcontainer/devcontainer.json) |
| Prompt & Docs | Onboarding prompt plus a feature-rich README for future collaborators. | [`output/toolbox-base/PROMPT`](output/toolbox-base/PROMPT), [`output/toolbox-base/README.md`](output/toolbox-base/README.md) |
| Work Log | Comprehensive record of work conducted on the ToolboxStack component. | [`collab/WORKLOG.md`](collab/WORKLOG.md) |
| Collaboration Notes | Shared design prompts and coordination notes for toolbox evolution. | [`collab/`](collab) |
---
## Quick Start
```bash
cd output/toolbox-base
./build.sh # build the image with UID/GID matching your host
./run.sh up # launch the toolbox-base service in the background
docker exec -it tsysdevstack-toolboxstack-toolbox-base zsh
```
Use `./run.sh down` to stop the container when you are finished.
---
## Contribution Tips
- Document every tooling change in both the `PROMPT` and `README.md`.
- Prefer installing CLIs via `aqua` and language runtimes via `mise` to keep the environment reproducible.
- Keep cache directories (`.build-cache/`, mise mounts) out of Git—they are already covered by the repo's `.gitignore`.
- Update the work log in `collab/WORKLOG.md` with detailed entries for all significant work.
- Follow the README maintenance guide in `collab/README-Maintenance.md` to keep documentation up to date.
---
## 🧭 Working Agreement
- **Stacks stay in sync.** When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
- **Collab vs Output.** Use `collab/` for planning and prompts, keep runnable artifacts under `output/`.
- **Document forward.** New workflows should land alongside tests and a short entry in the appropriate README table.
- **AI Agent Coordination.** Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.
- **Work Log Maintenance.** Keep `collab/WORKLOG.md` up to date with detailed entries including timestamps, activities, challenges, solutions, learnings, and feelings.
---
## 🤖 AI Agent
This stack is maintained by **ToolboxBot**, an AI agent focused on ToolboxStack workspace management.
---
## 📄 License
See [LICENSE](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.