pt/setup_env
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add what you get section to readme

Browse Source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Paul Trowbridge 2026-05-10 04:52:54 -04:00
parent 21a60534ce
commit d5de2c127c
1 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -43,6 +43,79 @@ Run manually on machines that need them:
./reinstall_nvchad.sh # Wipe and reinstall NvChad from scratch ./reinstall_nvchad.sh # Wipe and reinstall NvChad from scratch
``` ```
## What you get
### Packages
tmux, vim, git, fzf, ripgrep, pspg, bat — installed via apt on fresh setup.
### Shell aliases
| Alias | What it does |
|---|---|
| `ll` / `la` / `l` | Long, all, compact ls |
| `lb` | lsblk with filesystem info |
| `gs` | `git status -s` |
| `ga` | Interactive git add via fzf |
| `gx` | Interactive git checkout via fzf |
| `gc` | `git commit -v` |
| `gr` | `git reset HEAD` |
| `gd` | `git difftool` |
| `gl` | Pretty git log graph |
| `vc` | `git add -u`, commit with timestamp, push |
| `td` | Find unchecked todos with ripgrep |
| `tdp` / `tdtp` | Priority todos (🔼 / ⏫) |
| `tdo` / `tdop` | Open todo in nvim at exact line |
| `tstart` / `tstop` | Start/stop time tracking on a todo |
| `treport` / `tweek` | Time tracking report / week view |
| `cj` | `cd` to journal directory |
| `jr` / `hc` | Sync journal / hc notes repos |
| `ons` | List open nvim swap files in current tree |
### Database query aliases (requires `.bashrc_local` vars)
| Alias | What it does |
|---|---|
| `xnspa([args])` | fzf-select open nvim swap file → run via `$PG` → VisiData (CSV) |
| `xnsp` | Same → pspg |
| `xns` | Same → raw output |
| `xmspa()` | fzf-select swap file → run via `$MSC` → VisiData (pipe-delimited) |
| `xmsp` | Same → pspg |
| `xms` | Same → raw output |
### Neovim (NvChad)
Plugins:
| Plugin | Purpose |
|---|---|
| conform.nvim | Formatting (`g+w` or `<leader>fm`) |
| nvim-lspconfig | LSP support |
| nvim-tree | File explorer |
| telescope | Fuzzy finder |
| nvim-treesitter | Syntax highlighting |
| gitsigns | Git blame and diff signs |
| mason | Formatter/LSP installer (`:MasonInstall <tool>`) |
| obsidian.nvim | Obsidian vault integration (skipped if no vaults found) |
| transparent.nvim | Transparent background |
Keymaps:
| Key | What it does |
|---|---|
| `g+w` / `<leader>fm` | Format file |
| `<leader>gb` | Git blame |
| `<leader>ts` | Start time tracking on todo under cursor |
| `<leader>tp` | Stop time tracking |
| `<leader>tr` | Time report float |
| `<leader>tw` | Time week float |
### Prompt
`bash-git-prompt` — shows branch, dirty state, ahead/behind in the shell prompt (only inside git repos).
---
## Dotfile deployment ## Dotfile deployment
All config files are symlinked, not copied — editing `~/.<file>` edits the repo file directly. `git status` always shows config drift. All config files are symlinked, not copied — editing `~/.<file>` edits the repo file directly. `git status` always shows config drift.