Project Metadata

Project metadata gives people and tools quick access to useful project URLs and notes without encoding them in scripts.

Homepage

Set a top-level homepage as the default target for zap launch:

homepage: http://localhost:3000

zap launch
zap home

Links

Links are named URLs for docs, dashboards, staging environments, and other project resources.

links:
  - name: API Docs
    url: http://localhost:${API_PORT}/docs
  - name: Staging
    url: https://staging.example.com
  - name: Figma
    url: https://figma.com/file/abc123

zap open
zap launch "API Docs"
zap links
zap open "API Docs"
zap o "API Docs"
zap open --home

zap open opens an interactive picker for the homepage and configured links. Pass a link name, use zap open --home, or use zap launch when you want to open a URL without prompting.

Link URLs support ${VAR} interpolation from root env files and assigned ports.

Notes

Notes are top-level project text that can include interpolated env values.

env: [.env]
notes: |
  Frontend: http://localhost:${FRONTEND_PORT}
  API: http://localhost:${API_PORT}

zap notes
zap notes --json