chopsticks/QUICKSTART.md
m1ngsama 565f2fc80b
Some checks are pending
test / startup (macos-latest) (push) Waiting to run
test / startup (ubuntu-latest) (push) Waiting to run
test / shellcheck (push) Waiting to run
docs: full README update — accurate keybindings, :ChopsticksStatus, lazy count fix
- Add :ChopsticksStatus to features table, LSP section, troubleshooting
- Add ,? cheat sheet, ,mp preview, toggle keys to keybinding reference
- Add missing bindings: [<Space>], ,E, ,gl, ,bd, ,cp, ,cf, ,wa, ,F, ,W
- Fix lazy-loaded count: 7 (not 6)
- Update architecture descriptions to match current modules
- Add health check section to QUICKSTART
- Add :ChopsticksStatus to cheat sheet sidebar
2026-04-22 15:25:40 +08:00

100 lines
2 KiB
Markdown

# Quick Start
Five minutes from zero to a working Vim setup.
## Install
```bash
curl -fsSL https://raw.githubusercontent.com/m1ngsama/chopsticks/main/get.sh | bash
```
Open vim. First launch auto-installs plugins — **wait 30-60s, don't close vim**. Restart when done.
## Modes
| Mode | Enter | Leave |
|------|-------|-------|
| Normal | startup default | — |
| Insert | `i` / `a` / `o` | `Esc` or `jk` |
| Visual | `v` / `V` | `Esc` |
## Survival
```
Esc / jk back to Normal
,w save
,x save + quit
:q! force quit
Ctrl+s save from any mode
,? cheat sheet (toggle sidebar)
```
## Find things
```
Ctrl+p fuzzy find file (git-aware)
,rg ripgrep project
,b search buffers
,fh recent files
,e file browser
,, last file
```
## Write code
```
gd go to definition
K hover docs
,rn rename symbol
,ca code action
,f format
,cr run current file
Tab / S-Tab cycle completions
```
**First time in a new language?** Run `:LspInstallServer` — it auto-detects filetype and installs the right server. Do this once per language.
## Git
```
,gs status (s=stage, cc=commit)
,gd diff
,gb blame
,gp push
]x / [x conflict markers
```
## Edit
```
s + 2 chars EasyMotion jump
gc toggle comment
cs"' change surrounding " to '
Alt+j / Alt+k move line
,u undo tree
,y clipboard yank
```
## Navigate
```
Ctrl+h/j/k/l splits + tmux panes
,h / ,l prev / next buffer
,z maximize window
,tv / ,th terminal
```
## Markdown
```
,mp preview in browser
,mt table of contents
```
## Health check
```
:ChopsticksStatus see what's installed and what's missing
```
See [README](README.md) for the full reference. See the [wiki](https://github.com/m1ngsama/chopsticks/wiki) for deep dives.