docs: improve README with requirements, CLI flags, env vars, build instructions#17
Merged
Merged
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves README.md based on thorough codebase analysis to fill gaps in documentation and fix inaccuracies.
Changes
New sections
run,agent,cleanup, andguisubcommands with defaults sourced directly frominternal/app/cli.goandinternal/app/gui.goTAILSTICK_AUTH_KEY,TAILSTICK_EPHEMERAL_AUTH_KEY,TAILSTICK_API_KEY,TAILSTICK_OPERATOR_PASSWORD) and references.env.examplego build,make build-all,go test ./..., and available Makefile targetsFixes
PLAN.md(file does not exist in repo) → replaced with link toCONTRIBUTING.md--daysand--custom-daysflagslinux/arm64andwindows/arm64)agent --onceexampleVerification
All flag names, defaults, and behaviors verified against:
internal/app/cli.go— CLI subcommands and flag definitionsinternal/app/gui.go— GUI flag definitionsinternal/model/types.go— lease modes and channelsinternal/platform/platform.go— OS requirements and pathsinternal/config/config.go— config loading and env var resolution.github/workflows/release.yml— release matrixMakefile— build targetsFiles changed
README.md(+103 / -7)