Skip to content

Commit 53dd8a1

Browse files
committed
Add commands
1 parent 45c3868 commit 53dd8a1

5 files changed

Lines changed: 315 additions & 1 deletion

File tree

‎assets/commands/index.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4350,6 +4350,7 @@ llc.md
43504350
lldb.md
43514351
lldpctl.md
43524352
lli.md
4353+
llm-install.md
43534354
llm-keys.md
43544355
llm-logs.md
43554356
llm-models.md
@@ -4554,6 +4555,7 @@ machinectl.md
45544555
machma.md
45554556
macmon.md
45564557
macptopbm.md
4558+
mado.md
45574559
maestral.md
45584560
mafft.md
45594561
magento.md
@@ -6693,6 +6695,7 @@ python3.4.md
66936695
python3.md
66946696
pytorch.md
66956697
pyversions.md
6698+
pyxel.md
66966699
q.md
66976700
qalc.md
66986701
qbittorrent.md

‎assets/commands/llm-install.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# TAGLINE
2+
3+
Install Python packages into the same environment as llm
4+
5+
# TLDR
6+
7+
**Install a plugin** from PyPI
8+
9+
```llm install [llm-claude-3]```
10+
11+
**Upgrade** a package already in that environment
12+
13+
```llm install -U [llm]```
14+
15+
**Editable** install of a local plugin
16+
17+
```llm install -e [path/to/plugin]```
18+
19+
**Reinstall** even when the package is already current
20+
21+
```llm install --force-reinstall [llm-claude-3]```
22+
23+
Include **pre-releases**
24+
25+
```llm install --pre [plugin-name]```
26+
27+
**Remove** a package from the llm environment
28+
29+
```llm uninstall [llm-claude-3]```
30+
31+
# SYNOPSIS
32+
33+
**llm install** [_options_] [_packages_...]
34+
35+
**llm uninstall** [**-y**] _packages_...
36+
37+
# PARAMETERS
38+
39+
_packages_
40+
> One or more project names (PyPI) or, with **-e**, a local path. **llm install** with no packages prints help.
41+
42+
**-U**, **--upgrade**
43+
> Upgrade each named package to the latest version pip will accept.
44+
45+
**-e** _PATH_, **--editable** _PATH_
46+
> Install the project at _PATH_ in editable mode.
47+
48+
**--force-reinstall**
49+
> Reinstall even when the package is already up to date.
50+
51+
**--no-cache-dir**
52+
> Do not use pip's download cache.
53+
54+
**--pre**
55+
> Allow pre-release and development versions.
56+
57+
**-y**, **--yes**
58+
> **llm uninstall** only. Skip the confirmation prompt.
59+
60+
**-h**, **--help**
61+
> Help for **llm install** or **llm uninstall**.
62+
63+
# DESCRIPTION
64+
65+
**llm install** runs pip inside the same Python environment that provides the **llm** command. That is how model plugins (for example **llm-claude-3** or **llm-ollama**) become visible to **llm models** and **llm prompt**. Packages installed with a different **pip** or virtualenv are not picked up.
66+
67+
**llm uninstall** removes packages from that same environment. It asks for confirmation unless **-y** is given.
68+
69+
# CAVEATS
70+
71+
Subcommand of **llm**, not a separate binary. A Homebrew or Nix **llm** and a **pip install llm** are different environments; install plugins with the **llm** you actually run. **llm install -U llm** upgrades the tool inside its current environment and can move ahead of the distro package. Package names and versions go to pip, so a typo installs nothing useful and a broad upgrade can change unrelated plugins.
72+
73+
# INSTALL
74+
75+
```brew: brew install llm```
76+
77+
```nix: nix profile install nixpkgs#llm```
78+
79+
<!-- packages: 2026-10-02 -->
80+
81+
# SEE ALSO
82+
83+
[llm](/man/llm)(1), [llm-keys](/man/llm-keys)(1), [llm-models](/man/llm-models)(1), [pip](/man/pip)(1)
84+
85+
# RESOURCES
86+
87+
```[Source code](https://github.com/simonw/llm)```
88+
89+
```[Homepage](https://llm.datasette.io)```
90+
91+
```[Documentation](https://llm.datasette.io/en/stable/plugins/installing-plugins.html)```
92+
93+
<!-- verified: 2026-10-02 -->

‎assets/commands/llm.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,4 @@ Cloud models require API keys stored via **llm keys set**. Conversation logs are
125125

126126
# SEE ALSO
127127

128-
[llm-keys](/man/llm-keys)(1), [llm-logs](/man/llm-logs)(1), [llm-models](/man/llm-models)(1), [ollama](/man/ollama)(1), [chatgpt](/man/chatgpt)(1)
128+
[llm-install](/man/llm-install)(1), [llm-keys](/man/llm-keys)(1), [llm-logs](/man/llm-logs)(1), [llm-models](/man/llm-models)(1), [ollama](/man/ollama)(1), [chatgpt](/man/chatgpt)(1)

‎assets/commands/mado.md‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# TAGLINE
2+
3+
Fast Markdown linter for CommonMark and GitHub Flavored Markdown
4+
5+
# TLDR
6+
7+
**Check** the current directory
8+
9+
```mado check```
10+
11+
**Check** specific files or directories
12+
13+
```mado check [docs/] [README.md]```
14+
15+
**Exclude** paths by glob (comma-separated)
16+
17+
```mado check --exclude "[**/node_modules/**]" [docs/]```
18+
19+
Use a **config file**
20+
21+
```mado --config [path/to/mado.toml] check [docs/]```
22+
23+
Print violations like **mdl**
24+
25+
```mado check --output-format [mdl] [docs/]```
26+
27+
**Shell completion**
28+
29+
```mado generate-shell-completion [bash]```
30+
31+
# SYNOPSIS
32+
33+
**mado** [**--config** _file_] **check** [_options_] [_paths_...]
34+
35+
**mado generate-shell-completion** _shell_
36+
37+
# PARAMETERS
38+
39+
**--config** _file_
40+
> TOML file used instead of the discovered **mado.toml**. Place it before the subcommand.
41+
42+
**check** [_paths_...]
43+
> Lint Markdown files. Directories are walked. Default path is **.**. Non-terminal stdin is linted as one document and the path arguments are ignored.
44+
45+
**--output-format** _format_
46+
> **concise** (default), **mdl**, or **markdownlint**. Overrides **output-format** in the config file.
47+
48+
**--quiet**
49+
> Print violations only. Suppresses the success line. ORed with **quiet** in the config file.
50+
51+
**--exclude** _globs_
52+
> Comma-separated globs to skip. Replaces the **exclude** list from the config file for this run.
53+
54+
**generate-shell-completion** _shell_
55+
> Print a completion script. _shell_ is **bash**, **elvish**, **fish**, **powershell**, or **zsh**.
56+
57+
**-h**, **--help**
58+
> Help. **mado** with no subcommand does the same.
59+
60+
**-V**, **--version**
61+
> Print the version.
62+
63+
# DESCRIPTION
64+
65+
**mado** is a Rust linter for CommonMark and GitHub Flavored Markdown. It checks the markdownlint rule set (MD001 through MD047, with gaps) and exits 0 when every file passes, printing **All checks passed!** unless **--quiet** is set. Any violation exits non-zero after a count of errors.
66+
67+
With a terminal on stdin it lints the given paths in parallel. With a pipe it lints that text instead.
68+
69+
# CONFIGURATION
70+
71+
**mado.toml** or **.mado.toml** in the working directory is loaded first. If neither exists, mado reads the user config: **~/.config/mado/mado.toml** on Linux and macOS, **~\AppData\Roaming\mado\mado.toml** on Windows.
72+
73+
```toml
74+
[lint]
75+
output-format = "concise"
76+
respect-gitignore = "repository-only"
77+
exclude = ["**/node_modules/**"]
78+
79+
[lint.md013]
80+
line-length = 80
81+
code-blocks = false
82+
tables = false
83+
```
84+
85+
**respect-gitignore** is **never**, **repository-only** (default: only inside a Git, worktree, submodule, or jj tree), or **always** (also when the tree has no Git metadata, such as a source archive). **respect-ignore** controls **.ignore** files. The global Git ignore file and **.git/info/exclude** are never read.
86+
87+
Rule options live under **[lint.MD###]** (heading style, line length, allowed HTML elements, and so on). A JSON Schema for the file is shipped in the repository.
88+
89+
# CAVEATS
90+
91+
This is not the Node **markdownlint** CLI and it does not autofix. The upstream README marks MD003, MD007, MD020, MD027, and MD032 as unstable, and some rule options are unsupported. **--exclude** on the command line replaces the configured exclude list rather than adding to it. A piped run does not lint the paths you also passed.
92+
93+
# INSTALL
94+
95+
```pacman: sudo pacman -S mado```
96+
97+
```apk: sudo apk add mado```
98+
99+
```brew: brew install mado```
100+
101+
```nix: nix profile install nixpkgs#mado```
102+
103+
<!-- packages: 2026-10-02 -->
104+
105+
# SEE ALSO
106+
107+
[markdownlint](/man/markdownlint)(1), [vale](/man/vale)(1), [prettier](/man/prettier)(1), [glow](/man/glow)(1)
108+
109+
# RESOURCES
110+
111+
```[Source code](https://github.com/akiomik/mado)```
112+
113+
<!-- verified: 2026-10-02 -->

‎assets/commands/pyxel.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# TAGLINE
2+
3+
Retro game engine and resource editor for Python
4+
5+
# TLDR
6+
7+
**Run** a game script
8+
9+
```pyxel run [01_hello_pyxel.py]```
10+
11+
**Rerun** when files in a directory change
12+
13+
```pyxel watch [.] [game.py]```
14+
15+
**Edit** sprites, tilemaps, and sound (creates the file if missing)
16+
17+
```pyxel edit [my_resource.pyxres]```
18+
19+
**Package** a directory into a **.pyxapp**
20+
21+
```pyxel package [src] [src/main.py]```
22+
23+
**Play** a packaged app
24+
25+
```pyxel play [game.pyxapp]```
26+
27+
Copy the **bundled examples** into **./pyxel_examples**
28+
29+
```pyxel copy_examples```
30+
31+
# SYNOPSIS
32+
33+
**pyxel**
34+
35+
**pyxel run** _script.py_
36+
37+
**pyxel watch** _directory_ _script.py_
38+
39+
**pyxel play** _app.pyxapp_
40+
41+
**pyxel edit** [_resource.pyxres_]
42+
43+
**pyxel package** _app_dir_ _startup.py_
44+
45+
**pyxel app2exe** _app.pyxapp_
46+
47+
**pyxel app2html** _app.pyxapp_
48+
49+
**pyxel copy_examples**
50+
51+
# PARAMETERS
52+
53+
**run** _script.py_
54+
> Run a Python file. A missing **.py** suffix is added. The script's directory is put on **sys.path**.
55+
56+
**watch** _directory_ _script.py_
57+
> Run _script.py_ and restart it when any file under _directory_ changes. Stop with **Ctrl+C** (**Cmd+C** on macOS). The script must live inside _directory_.
58+
59+
**play** _app.pyxapp_
60+
> Unpack and run a Pyxel application file. **.pyxapp** is added when the name has no suffix. A **.zip** path is accepted as-is.
61+
62+
**edit** [_resource.pyxres_]
63+
> Open the image, tilemap, sound, and music editors. Omitted name becomes **my_resource.pyxres**. A missing file is created. A missing **.pyxres** suffix is added.
64+
65+
**package** _app_dir_ _startup.py_
66+
> Write _app_dir_**.pyxapp** (a zip) in the current directory. _startup.py_ must be inside _app_dir_. Comment headers in that file (**title**, **author**, **desc**, **site**, **license**, **version**) are stored as zip metadata and printed by **play**. **.gif**, **.zip**, and **__pycache__** are left out.
67+
68+
**app2exe** _app.pyxapp_
69+
> Build a windowed executable with PyInstaller. Fails if PyInstaller is not installed.
70+
71+
**app2html** _app.pyxapp_
72+
> Write _name_**.html** in the current directory. The page loads Pyxel's web runtime and embeds the **.pyxapp**.
73+
74+
**copy_examples**
75+
> Replace **./pyxel_examples** with the examples shipped in the package.
76+
77+
# DESCRIPTION
78+
79+
**pyxel** is the command installed with the Pyxel Python library, a retro game engine with a fixed 16-color palette, four sound channels, image banks, and tilemaps. Games are ordinary Python scripts (**import pyxel**, then **pyxel.init** and **pyxel.run**). The same command opens the bundled resource editor and packs a project for other machines or for the browser.
80+
81+
With no arguments it prints the version and the command list.
82+
83+
While a game or the editor is running: **Esc** quits; **Alt+1** saves a screenshot to the desktop; **Alt+3** saves up to 10 seconds of capture; **Alt+Enter** toggles fullscreen; **Alt+0** toggles the performance monitor. On macOS the **Alt** shortcuts use **Option**.
84+
85+
# CAVEATS
86+
87+
Needs Python 3.11 or newer. The **pyxel** command comes from **pip install pyxel** (or a distro package of that project), not from the Python standard library. Games open a graphical window; this is not a terminal game. **watch** errors if the script is outside the watched directory. **app2exe** depends on PyInstaller and writes build files in the working directory. **app2html** needs network access when the page is opened, because it loads the web runtime from a CDN pinned to the installed Pyxel version.
88+
89+
# INSTALL
90+
91+
```nix: nix profile install nixpkgs#pyxel```
92+
93+
<!-- packages: 2026-10-02 -->
94+
95+
# SEE ALSO
96+
97+
[python](/man/python)(1), [pygame](/man/pygame)(1), [pip](/man/pip)(1)
98+
99+
# RESOURCES
100+
101+
```[Source code](https://github.com/kitao/pyxel)```
102+
103+
```[Documentation](https://kitao.github.io/pyxel/web/user-guide/)```
104+
105+
<!-- verified: 2026-10-02 -->

0 commit comments

Comments
 (0)