Skip to content

docs: document v0.1.0 installation #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jiangyuer018 wants to merge 1 commit into from
Closed

docs: document v0.1.0 installation #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 20 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
nodkey lets an AI coding agent use a secret or an SSH key only after a
person approves that one request on a phone.

**Status:** on 2026-10-15, the code of version 1 is on `main`, and the
test with a real Telegram bot
([#17](https://github.com/code6x/nodkey/issues/17)) is done. There is no
release yet. Try it on a test setup first. See the
**Status:** on 2026-10-15, the code of version 1 is on `main`, the test with
a real Telegram bot ([#17](https://github.com/code6x/nodkey/issues/17)) is
done, and the first release, [v0.1.0](https://github.com/code6x/nodkey/releases/tag/v0.1.0),
is available. Try it on a test setup first. See the
[v1 milestone](https://github.com/code6x/nodkey/milestone/1).

## How it works
Expand Down Expand Up @@ -48,17 +48,27 @@ clipboard, terminals and browser. Keep no SSH key or other way to get
root on the broker host on the agent machine
([docs/setup.md section 1](docs/setup.md#where-you-do-the-setup)).

1. **Install** `nodkey` on both machines. There is no release yet, so
build it from this repository with Go 1.26 or newer, on a trusted
machine, never on the agent machine:
1. **Install** `nodkey` on both machines. From a release, download the
tarball for your machine and `SHA256SUMS` from the
[release page](https://github.com/code6x/nodkey/releases). Check both as
described in [Verify a download](docs/releasing.md#verify-a-download),
then extract and install it:

```sh
tar -xzf nodkey_0.1.0_linux_amd64.tar.gz nodkey
install -o root -g root -m 0755 nodkey /usr/local/bin/nodkey
```

Copy the file straight to both machines, not through the agent machine.
**From the source**, build it with Go 1.26 or newer on a trusted machine,
never on the agent machine:

```sh
CGO_ENABLED=0 go build -trimpath -o nodkey ./cmd/nodkey
```

Copy the file straight to both machines, not through the agent
machine. On the broker host, `sha256sum nodkey` must print the same
SHA-256 as on the build machine. Install it as root:
On the broker host, `sha256sum nodkey` must print the same SHA-256 as on
the build machine. Install it as root:

```sh
install -o root -g root -m 0755 nodkey /usr/local/bin/nodkey
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ normal issues.

## Supported versions

There is no release yet. Until 1.0, only the latest release gets fixes.
Until 1.0, only the latest release (`v0.1.0`) gets fixes.
6 changes: 3 additions & 3 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ tar -xzf nodkey_0.1.0_linux_amd64.tar.gz nodkey
install -o root -g root -m 0755 nodkey /usr/local/bin/nodkey
```

**From the source.** There is no release yet on 2026-10-15. Build nodkey
with Go 1.26 or newer, on a trusted machine. Never build it on an agent
machine: the agent could change the build.
**From the source.** Build nodkey with Go 1.26 or newer, on a trusted
machine. Never build it on an agent machine: the agent could change the
build.

```sh
git clone https://github.com/code6x/nodkey.git
Expand Down
Loading