Imported from axatbhardwaj/Haoshoku (
AGENTS.md). Install upstream withnpx skills add axatbhardwaj/Haoshoku. Copyright stays with the author.
Haoshoku
Multi-distro Linux setup and configuration toolkit (JavaScript/Bun).
Files
| File | What | When to read |
|---|---|---|
haoshoku.js |
CLI entry point, OS detection | Modifying CLI args, adding new OS targets |
package.json |
Dependencies and npm scripts | Adding deps, updating scripts |
README.md |
User documentation, feature list | Understanding features, installation options |
CHANGELOG.md |
Version history | Checking release notes |
info.txt |
Theme names and resource links | Reference for KDE theme components |
bun.lock |
Dependency lockfile (Bun) | Checking exact dependency versions |
AGENTS.md |
Codex copy of this file; keep both in sync | Editing repo guidance for either harness |
biome.json |
Lint/format config and fixture excludes | Changing lint rules or excluded fixtures |
BRANCH-NOTES.md |
Dated log of branch outcomes and test counts | Checking what a past branch delivered |
Subdirectories
| Directory | What | When to read |
|---|---|---|
src/ |
Core source code | Modifying setup logic, adding features |
configs/ |
Template configs for deployment | Adding/modifying terminal, app, or AI configs |
common/ |
Package lists for OS setup | Adding/removing packages to install |
tests/ |
Test suite | Writing tests, debugging test failures |
scripts/ |
Build and release scripts | Modifying release process |
docs/ |
Additional documentation | Understanding project details |
deskback/ |
Wallpaper assets | Adding wallpapers |
icons/ |
Icon assets | Adding icons |
video/ |
Remotion project for the README intro animation | Regenerating icons/haoshoku-readme.gif |
Install
# Option 1: Run with Bun (Recommended)
bun install
bun haoshoku.js
# Option 2: Install via npm
npm install -g haoshoku
haoshoku
Test
bun test
Lint
bun run lint
bun run format