FAQ

Is HookCI open source?

The agent and the hub are open source. The repository is at github.com/KCuppens/hookci. You can use the hosted hub or self-host it.

Do you see my code?

No. The agent clones your repo on your server and sends the hub only results, annotations, and logs. See Security and data. Logs can contain whatever your commands print, so redact secrets with redact.

What do I need to run it?

A Linux machine, amd64 or arm64, with systemd and cgroup v2 for isolation. The agent is one binary. See Install the agent.

Does it run on Windows or macOS?

The agent is Linux only. You can use a Linux VM on other systems. Native Windows and macOS agents are not offered.

Does it work with GitHub Enterprise?

Not documented as supported. The hub works with the GitHub App on github.com. If you need GitHub Enterprise, ask [email protected] and treat it as unsupported until confirmed.

What about GitLab or Bitbucket?

Only GitHub is supported.

Does it support Docker?

Yes in two ways. Detection recognises docker-compose projects, and your jobs can call Docker if it is available on the agent host. Be careful: access to the Docker socket is close to root access, so only use it with repositories you trust. Docker based deploys with compose-bluegreen are planned.

How is it different from GitHub Actions?

Checks run on your own server instead of shared runners, and results appear as GitHub Check Runs. You write .hookci.yml rather than workflow files, and a lot is auto-detected. It is not a drop-in replacement: Actions marketplace actions do not run here.

How does the cost compare with Actions?

It depends on your usage and plan. You pay for your own server, plus the hosted hub if you use it. See pricing. Self-hosting the hub has no HookCI fee, but you pay Cloudflare.

Can I run it without a hub?

Yes. hookci run runs your checks locally with no account. See Run checks locally.

Is it safe for public repositories?

Keep trust: collaborators and forks: gated, and limit egress. Avoid trust: all. See Trust and forks.

Can I run several agents?

Yes. Each agent is paired separately and listed in Slack App Home. How many are included depends on your plan: see pricing.

Which notifications are available?

GitHub Checks and Slack are available. Telegram, Linear, and deploys are planned.

How do I leave and delete my data?

Revoke the agent, uninstall the GitHub App, and use /hookci delete-my-data. Data is purged within 30 days of uninstall. See Security and data.

Does it work with monorepos?

You can define several jobs and set run commands for any subdirectory. Auto-detection is based on the repo root, so for monorepos write a .hookci.yml. See Examples by stack.

Where do I get help?

[email protected], or open an issue on the repository.