Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
126 lines (93 loc) · 2.4 KB

DEVELOPMENT.md

File metadata and controls

126 lines (93 loc) · 2.4 KB

Development

Prerequisites

  • Rust (stable)
  • Node.js 18+
  • Tauri CLI v2
  • Python 3 (for model download helper)
  • Platform-specific build tools:

Setup

npm run setup -- --yes
python3 -c "from huggingface_hub import snapshot_download; snapshot_download('Zyphra/ZUNA')"
npm run tauri dev

Build

npm run tauri build

Daemon packaging checks

Validate that release artifacts include the skill-daemon sidecar:

# macOS/Linux auto-detect host OS
npm run test:daemon-packaging

# explicit targets
npm run test:daemon-packaging:mac
npm run test:daemon-packaging:linux
npm run test:daemon-packaging:win

Build + verify in one step:

bash scripts/test-daemon-packaging.sh --os macos --build
bash scripts/test-daemon-packaging.sh --os linux --build
powershell -ExecutionPolicy Bypass -File scripts/test-daemon-packaging.ps1 -Build

Optional build acceleration

npm run setup:build-cache
npm run setup:llama-prebuilt

Environment toggles:

  • SKILL_NO_SCCACHE=1
  • SKILL_NO_MOLD=1
  • unset LLAMA_PREBUILT_DIR (force local llama.cpp build)
  • SKILL_DAEMON_SERVICE_AUTOINSTALL=0 (disable daemon background-service auto-install for local testing)

Data health check

npm run health
# or
SKILL_DIR=/path/to/.skill npm run health

Docs/README sync helpers

npm run sync:readme:supported
npm run sync:readme:supported:check

Pre-commit checks

  • cargo clippy --all-targets --all-features -- -D warnings (in src-tauri)
  • npm run check

Emergency bypass:

git commit --no-verify

Versioning

npm run bump
npm run bump 1.2.0

This syncs versions across app manifests and compiles changelog fragments.

Important: The bump command now includes safety checks to prevent accidental multiple bumps:

  • It verifies that the current version has a git tag (vX.X.X) locally
  • It verifies that the tag has been pushed to a remote
  • If either check fails, the bump will be aborted with instructions

To bypass these checks (use with caution):

npm run bump --force

After a successful bump, create and push the version tag:

npm run tag

Or manually:

git tag vX.X.X
git push --tags

Release (local)

act push
bash release.sh --dry-run
SKIP_UPLOAD=1 bash release.sh