diff --git a/README.md b/README.md index 4843e81..cc5bad0 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,79 @@ Run manually on machines that need them: ./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 `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 `) | +| obsidian.nvim | Obsidian vault integration (skipped if no vaults found) | +| transparent.nvim | Transparent background | + +Keymaps: + +| Key | What it does | +|---|---| +| `g+w` / `fm` | Format file | +| `gb` | Git blame | +| `ts` | Start time tracking on todo under cursor | +| `tp` | Stop time tracking | +| `tr` | Time report float | +| `tw` | Time week float | + +### Prompt + +`bash-git-prompt` — shows branch, dirty state, ahead/behind in the shell prompt (only inside git repos). + +--- + ## Dotfile deployment All config files are symlinked, not copied — editing `~/.` edits the repo file directly. `git status` always shows config drift.