Documentation

Hack keeps the parts needed to run a project together: services, environment, secrets, local URLs, startup helpers and logs. The setup lives with your repository.

v4 is the current stable line. v5, the next major version, is in prerelease. Choose v5 in the version selector for its docs and the upgrade guide.

Start with Install, then Getting started.

Understand the projectCopy Anchor Link

• Core concepts: projects, services and running instances.
• Environment and secrets: share configuration and keep keys separate.
• Lifecycle: start helpers with the project.
• Sessions: persistent workspaces.

Do a taskCopy Anchor Link

• Run and inspect a project
• Choose where a command runs
• Work on another branch
• Share environment and secrets
• Manage helpers and tunnels
• Use a cloud agent or another host

Work with an agentCopy Anchor Link

Agent handoff supplies this version's documentation exports and setup instructions. Agent integrations describes the matching optional client setup.

Find details or diagnose a problemCopy Anchor Link

Use the CLI overview to choose a command, the command reference for flags, contracts for schemas and agent interfaces, and Architecture for the runtime model. Run hack doctor on the machine running Hack and follow the specific diagnosis.

---

Source: v4.2.4 · docs/site/index.md.