alexion/dotfiles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: convention for usage documentation.

Browse Source
This commit is contained in:
alexion
2026-07-04 11:31:42 -04:00
parent d5aacad86e
commit 46fa6e5687
5 changed files with 65 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
.gitea/README.md
View File

@@ -14,12 +14,13 @@ fish -c 'dot init'
## Commands
| Command | Description |
| -------------- | ----------------------------------------------------------------------------------------- |
| `dot help` | Lists available commands. |
| `dot init` | Bootstraps the dotfiles repo on a new machine. |
| `dot <custom>` | Any file under `~/.config/dot/commands/` (currently `install`); run `dot help` for the live list. |
| `dot <git>` | Everything else is passed to `git`. |
| Command | Description |
| ----------------------- | ----------------------------------------------------------------------------------------- |
| `dot help` | Lists available commands. |
| `dot init` | Bootstraps the dotfiles repo on a new machine. |
| `dot install <pkgs>` | Installs the given pacman packages and appends them to the tracked list (`~/.config/dot/packages/pacman`). |
| `dot install --restore` | Reinstalls every package from the tracked list. |
| `dot <git>` | Everything else is passed to `git`. |
See [CLAUDE.md](../.config/dot/CLAUDE.md) for the `dot` tool's internal
architecture, bootstrap logic, subcommand dispatch, and test suite.