Expand README with comprehensive command reference and troubleshooting - #43
Merged
Conversation
Document what every installed tool does on Linux and the commands you actually use day to day, in tables. - Command reference for fish (plus its omf/fzf/z/pisces plugins and key bindings), nushell, nvim/NvChad, helix, node/volta/npm/pnpm/yarn/git0/ vite/turbo, bun, rootless docker, starship, fzf, ripgrep, systemd and journalctl, pacstall, code-server - Package-manager equivalents across Ubuntu/Debian, Fedora, Arch, AUR, Alpine, macOS and Termux, plus the proot-distro flow on Android - Install modes table, including that CLI `all` omits `code` and that neither form of `all` includes `sudo` - "Files This Script Touches" audit table, flagging that systeminfo deletes the system MOTD and starship overwrites starship.toml - Companion scripts: get-node.sh, clean-server-disk.sh (stage-by-stage), misc-setup/ - Troubleshooting table and a table of contents Component table now also lists the install source and a verify command for each component. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EVv96XX7xESqrQAs4ZRW9u
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
This PR significantly expands the README documentation for the server shell setup script with detailed command references, usage examples, and troubleshooting guidance.
Summary
The README has been restructured and greatly expanded to serve as a complete reference guide for all installed tools and components. This makes the documentation more discoverable and useful for users after installation.
Key Changes
Added table of contents — New "Contents" section with links to all major sections for easier navigation
Enhanced install documentation — Added "Install Modes" table explaining the differences between interactive menu,
all, and component-specific invocations; clarified the-s --argument forwarding syntaxExpanded Components table — Now includes installation method and verification command for each component, plus notes about distro-specific behavior (e.g., pacstall Ubuntu/Debian only)
Comprehensive Fish aliases documentation — Added detailed descriptions and notes for each function, explaining what they do and any caveats (e.g.,
inis hardcoded to apt)New "Command Reference" section — Extensive subsections for each major tool:
New "Files This Script Touches" section — Audit table showing what paths are modified, by which components, and what they contain
New "Companion Scripts" section — Documents
get-node.shandclean-server-disk.shwith usage examples and detailed cleanup stagesNew "Troubleshooting" section — Common issues and their fixes (password setup, piped install, shell not changing, component validation, rootless docker, etc.)
Implementation Details
docker run -it --rm <img> <cmd>) and common workflowshttps://claude.ai/code/session_01EVv96XX7xESqrQAs4ZRW9u