docs: update README/AGENTS for current codebase state
- README: added --host flag, toolchain check commands, docker output fix - AGENTS: documented --host bind address behavior, macOS bcopy fix, check-toolchain scripts, updated architecture tree
This commit is contained in:
@@ -15,9 +15,16 @@ mise install # installs go 1.26, node 22
|
||||
mise run build # → ./fetch
|
||||
```
|
||||
|
||||
### Toolchain check
|
||||
```bash
|
||||
mise run check-all # checks gcc, brew, mise, go, node, docker, colima
|
||||
mise run check-toolchain # core tools only
|
||||
mise run check-docker-toolchain # docker + compose + colima (macOS)
|
||||
```
|
||||
|
||||
### Docker
|
||||
```bash
|
||||
docker compose up --build
|
||||
mise run docker-up
|
||||
# Open http://localhost:8080
|
||||
```
|
||||
|
||||
@@ -27,9 +34,13 @@ docker compose up --build
|
||||
mise run build
|
||||
./fetch search --filter vocal
|
||||
|
||||
# Web server
|
||||
# Web server (local)
|
||||
mise run serve
|
||||
# Open http://localhost:8080
|
||||
# Open http://localhost:PORT (auto-assigned)
|
||||
|
||||
# Web server (Docker / network-accessible)
|
||||
./fetch serve --host 0.0.0.0 -p 8080
|
||||
# Open http://<host-ip>:8080
|
||||
|
||||
# Electron (macOS)
|
||||
mise run electron-deps
|
||||
@@ -61,18 +72,22 @@ electron/ Electron wrapper (spawns fetch serve as sidecar)
|
||||
├── preload.js context bridge
|
||||
└── package.json electron-builder config
|
||||
|
||||
scripts/
|
||||
├── extract_wavs.sh batch WAV extraction via akaiutil
|
||||
├── check-toolchain.sh verify gcc, brew, mise, go, node
|
||||
└── check-docker-toolchain.sh verify docker, compose, colima
|
||||
|
||||
third_party/akaiutil/ Vendored akaiutil 4.6.7 (C, GPLv2)
|
||||
scripts/extract_wavs.sh Bash wrapper for batch WAV extraction
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Component | Tech | External Deps |
|
||||
|-------------|--------------------|---------------|
|
||||
| CLI server | Go 1.26, stdlib | 0 |
|
||||
| Web UI | HTML/CSS/JS (vanilla) | 0 |
|
||||
| CLI server | Go 1.26, stdlib | 0 |
|
||||
| Web UI | HTML/CSS/JS (vanilla) | 0 |
|
||||
| Electron | Electron 33, electron-builder | Node deps |
|
||||
| Extraction | akaiutil (C), bash | vendored |
|
||||
| Extraction | akaiutil (C), bash | vendored C source |
|
||||
|
||||
Zero Go dependencies. The web UI uses no framework — vanilla JS, Web Audio API, Server-Sent Events.
|
||||
|
||||
@@ -84,6 +99,7 @@ See [open issues](https://git.notsosm.art/david/akai-utils/issues).
|
||||
|---|---------|--------|
|
||||
| — | Search, download, extract, pipeline (CLI) | done |
|
||||
| — | HTTP server + web UI + Electron shell | done |
|
||||
| — | Docker compose + mise toolchain + toolchain checks | done |
|
||||
| #1 | Disk Browser — browse AKAI filesystem in web UI | todo |
|
||||
| #2 | Disk Inspector — detailed disk metadata | todo |
|
||||
| #3 | WAV→Disk Packager — create AKAI ISOs from WAVs | todo |
|
||||
|
||||
Reference in New Issue
Block a user