docs: add README

This commit is contained in:
2026-03-04 01:43:04 +07:00
parent 7e759a1993
commit ea2f793b04

52
README.md Normal file
View File

@@ -0,0 +1,52 @@
# dev-tools
Populates a shared `dev-tools` Docker volume with dev tools using [mise](https://mise.jdx.dev/). Run once, mount everywhere.
## Prerequisites
Create the external volume:
```bash
docker volume create dev-tools
```
Optionally, set a GitHub token to avoid API rate limits:
```bash
cp .env.example .env
# fill in GITHUB_TOKEN
```
## Usage
```bash
docker compose up
```
## Tools
| Category | Tools |
| ---------------- | -------------------------------------------------- |
| Languages | Node 24, Python 3.11, Go 1.26, DuckDB 1 |
| Package managers | uv |
| Secrets | sops, age |
| Infra | mc (MinIO client), Supabase CLI |
| Dev utilities | bat, eza, ripgrep, fzf, jq, yq, just, gh, starship |
## Consuming the volume
```yaml
volumes:
- dev-tools:/tools
environment:
- PATH=/tools/shims:${PATH}
volumes:
dev-tools:
name: dev-tools
external: true
```
## Updating tools
Edit `mise.toml`, bump versions, re-run `docker compose up`.