Skip to content

[nightshift] readme-improvements: automated improvements#18

Merged
Microck merged 1 commit into
Microck:mainfrom
nightshift-micr:nightshift/readme-improvements
Apr 13, 2026
Merged

[nightshift] readme-improvements: automated improvements#18
Microck merged 1 commit into
Microck:mainfrom
nightshift-micr:nightshift/readme-improvements

Conversation

@nightshift-micr
Copy link
Copy Markdown
Contributor

Automated by Nightshift v3 (GLM 5.1).

Task: readme-improvements
Category: pr
Changes:

  1. New "Requirements" section — Documents elevated privileges (sudo on linux, admin on windows), debian/ubuntu + systemd requirement for linux, and Go 1.22+ for building.
  2. Complete CLI flag reference — Added detailed flag tables for all 4 subcommands (run, agent, cleanup, gui) with flag names, defaults, and descriptions.
  3. New "Environment variables" section — Documents the 4 common env vars and references .env.example.
  4. New "Building from source" section — Documents go build, make build-all, go test, and Makefile targets.
  5. Fixed stale PLAN.md link → replaced with CONTRIBUTING.md link.
  6. Fixed lease modes description — Removed hardcoded "1, 3, 7" days, now references --days and --custom-days flags accurately.
  7. Added arm64 architecture info — Release workflow builds for arm64 on both linux and windows.
  8. Added agent --once example — A commonly needed operation that was missing.

Merge if useful, close if not.

…structions

- Add requirements section (elevated privileges, supported OS, Go version)
- Document all CLI flags for run, agent, cleanup, and gui subcommands
- Add environment variables section with common variable names
- Add building from source section with Makefile targets
- Note arm64 release binaries in platform support
- Fix stale PLAN.md link -> CONTRIBUTING.md link
- Fix lease modes description (remove hardcoded '1,3,7', reference --days/--custom-days)
- Add agent --once example
@Microck Microck merged commit a5f3e50 into Microck:main Apr 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants