Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
repos:
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.10.0.1
hooks:
- id: shellcheck

- repo: https://github.com/golangci/golangci-lint
rev: v2.12.2
hooks:
- id: golangci-lint-full
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,41 @@ Build artifacts are written to `bin/`.
HYPERSTACK_URL="http://localhost:8000" task run
```

## Development

Install [pre-commit](https://pre-commit.com/) then run:

```bash
pre-commit install
```

Hooks run automatically on `git commit`. To run them manually:

```bash
pre-commit run --all-files
```

## Scripts

The `scripts/` directory is part of the public release because it shows how the
agent is built, installed, tested, and removed.

- `scripts/install_agent.sh`: VM install helper. Requires a gateway URL argument
or `GATEWAY_URL`; optionally sends `INFRAHUB_KEY` as a download authorization
header without persisting it.
- `scripts/install.sh`: advanced systemd installer for a local agent binary.
Requires `BINARY_SOURCE` and does not embed credentials.
- `scripts/uninstall_agent.sh`: removes the systemd service and agent runtime
files.
- `scripts/build.sh`: builds linux release artifacts and SHA-256 checksums.
- `scripts/serve.sh`: local Docker helper that serves `/download` and
`/version` for install/update tests.
- `scripts/e2e.sh`: local Docker end-to-end test helper.

Do not commit `.env` files, real gateway URLs, private IPs, credentials, tokens,
or customer-specific metadata into this repository. Use placeholders such as
`gateway.example.com` in docs and test fixtures.

## Configuration

The agent is configured through environment variables:
Expand Down
Loading