Skip to content

Commit 2cdf38d

Browse files
committed
Add commands
1 parent 2b5b38e commit 2cdf38d

3 files changed

Lines changed: 186 additions & 0 deletions

File tree

assets/commands/doc-engine.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# TAGLINE
2+
3+
Zero-config Markdown to PDF documentation engine using Typst
4+
5+
# TLDR
6+
7+
**Generate a PDF** from README.md with zero configuration
8+
9+
```doc-engine build```
10+
11+
**Convert a specific file** and override title and author
12+
13+
```doc-engine build CONTRIBUTING.md -o guide.pdf -t "Guide" -a "Team"```
14+
15+
**Use a different template** and accent color
16+
17+
```doc-engine build --template modern --accent teal```
18+
19+
**Check for Markdown errors** without generating PDF
20+
21+
```doc-engine build --dry-run```
22+
23+
**Install via pipx**
24+
25+
```pipx install doc-engine-cli```
26+
27+
# SYNOPSIS
28+
29+
**doc-engine** build [INPUT_FILE] [options]
30+
31+
**doc-engine** info
32+
33+
**doc-engine** --help | --version
34+
35+
# DESCRIPTION
36+
37+
**doc-engine** is a CLI tool that converts Markdown files into professionally styled PDF documents using Typst as the rendering backend. It auto-detects README.md, extracts metadata from Git, and produces high-quality technical or academic reports complete with cover page, table of contents, and syntax-highlighted code.
38+
39+
It requires no LaTeX, Pandoc, or manual configuration. The tool supports five built-in templates and custom accent colors. It can also perform source error checking with precise line/column reporting.
40+
41+
# PARAMETERS
42+
43+
**build** [_INPUT_FILE_]
44+
45+
> Convert the Markdown file to PDF. Defaults to auto-detecting README.md in the current directory.
46+
47+
**-o**, **--output** _file.pdf_
48+
49+
> Output file path. Default: <input>_doc.pdf
50+
51+
**-t**, **--title** _title_
52+
53+
> Document title. Defaults to first # heading or Git-derived.
54+
55+
**-a**, **--author** _name_
56+
57+
> Author name. Defaults to `git config user.name`.
58+
59+
**--template** _name_
60+
61+
> Template: academic (default), modern, minimal, technical, book.
62+
63+
**--accent** _color_
64+
65+
> Accent color (hex or named: blue, teal, rose, etc.).
66+
67+
**--bib** _file.bib_
68+
69+
> Bibliography file for IEEE-style references section.
70+
71+
**--dry-run**
72+
73+
> Validate Markdown and report errors without producing PDF.
74+
75+
**--open**
76+
77+
> Open the generated PDF after creation.
78+
79+
**--no-branding**
80+
81+
> Omit "doc-engine" attribution from footer.
82+
83+
# EXAMPLES
84+
85+
Basic zero-config usage in a project directory:
86+
87+
```doc-engine build```
88+
89+
Generate with custom options:
90+
91+
```doc-engine build docs/api.md -o api.pdf --template technical --accent "#7c3aed"```
92+
93+
# CAVEATS
94+
95+
Images in Markdown are rendered only as alt text (remote images not downloaded or embedded). Complex layouts may require reviewing the output PDF. Requires Python 3.10+ and the Typst Python bindings (installed automatically).
96+
97+
# SEE ALSO
98+
99+
[typst](/man/typst)(1), [pandoc](/man/pandoc)(1), [weasyprint](/man/weasyprint)(1)
100+
101+
# RESOURCES
102+
103+
```[Source code](https://github.com/leonardosalasd/doc-engine-cli)```
104+
105+
```[Documentation](https://github.com/leonardosalasd/doc-engine-cli#readme)```
106+
107+
<!-- verified: 2026-07-07 -->

assets/commands/index.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1723,6 +1723,7 @@ dnsx.md
17231723
do-release-upgrade.md
17241724
do.md
17251725
doas.md
1726+
doc-engine.md
17261727
docbook2html.md
17271728
dockdiver.md
17281729
docker-build.md
@@ -3923,6 +3924,7 @@ kyanos.md
39233924
kyma.md
39243925
l123.md
39253926
l2ping.md
3927+
l9gpu.md
39263928
labcoat.md
39273929
lambo-new.md
39283930
lambo.md

assets/commands/l9gpu.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# TAGLINE
2+
3+
GPU observability agent with Kubernetes and Slurm workload attribution
4+
5+
# TLDR
6+
7+
**Install** the Python package
8+
9+
```pip install l9gpu```
10+
11+
**Monitor NVIDIA GPUs** and emit OTLP telemetry
12+
13+
```l9gpu nvml_monitor --sink otel --cluster my-cluster```
14+
15+
**Quick test** without sending data
16+
17+
```l9gpu nvml_monitor --sink stdout --once```
18+
19+
**Monitor AMD GPUs**
20+
21+
```l9gpu amd_monitor --sink otel --cluster my-cluster```
22+
23+
**Monitor Intel Gaudi**
24+
25+
```l9gpu gaudi_monitor --sink otel --cluster my-cluster```
26+
27+
**Run via systemd** or Kubernetes DaemonSet (see Helm)
28+
29+
# SYNOPSIS
30+
31+
**l9gpu** _subcommand_ [options]
32+
33+
Common subcommands: nvml_monitor, amd_monitor, gaudi_monitor, slurm_monitor and others.
34+
35+
# DESCRIPTION
36+
37+
**l9gpu** is the core CLI for Last9 GPU Telemetry. It runs as a per-node agent that collects hardware metrics (NVML, amdsmi, hl-smi) from GPUs and enriches them with workload context from Kubernetes or Slurm before exporting standard OpenTelemetry (OTLP) metrics and logs.
38+
39+
This enables per-pod, per-job, per-user GPU accounting without building custom pipelines. It supports NVIDIA, AMD, and Intel Gaudi GPUs and integrates with any OTLP-compatible backend.
40+
41+
The package also provides related health check tooling.
42+
43+
# PARAMETERS
44+
45+
**--sink** _otel|stdout|file_
46+
47+
> Destination for telemetry (otel recommended for production).
48+
49+
**--cluster** _name_
50+
51+
> Cluster identifier attached to emitted data.
52+
53+
**--once**
54+
55+
> Run a single collection cycle and exit (useful for testing).
56+
57+
Other options and subcommands are listed via `l9gpu --help`.
58+
59+
Configuration can also be supplied via TOML files.
60+
61+
# CAVEATS
62+
63+
Requires appropriate vendor libraries or tools (NVML for NVIDIA, etc.) and Python 3.10+. Primarily intended for cluster operators; not a replacement for DCGM or full Prometheus exporters. Emits OTLP; a collector is typically used downstream for storage/visualization.
64+
65+
# SEE ALSO
66+
67+
[otel](/man/otel)(1), [dcgm](https://github.com/NVIDIA/DCGM)
68+
69+
# RESOURCES
70+
71+
```[Source code](https://github.com/last9/gpu-telemetry)```
72+
73+
```[Homepage](https://last9.io/gpu-observability/)```
74+
75+
```[Documentation](https://last9.io/docs/)```
76+
77+
<!-- verified: 2026-07-07 -->

0 commit comments

Comments
 (0)