Skip to content

Commit 14c2889

Browse files
authored
feat(cli): add setup-renderdoc command for one-step install (#181)
* feat(cli): add setup-renderdoc command for one-step install * refactor(doctor): simplify _make_build_hint to single return All three platform branches returned identical text after the setup-renderdoc unification. Collapse to a single return. * fix(doctor): check RENDERDOC_PYTHON_PATH and skip stale vulkan entries - _check_win_python_version: include RENDERDOC_PYTHON_PATH in search paths so pixi-local installs are found - _check_win_vulkan_layer: collect all registry entries and pick the first one whose JSON file actually exists, instead of failing on a stale entry from a previous install * fix(docs): add setup-renderdoc to commands.json category
1 parent 6f2952f commit 14c2889

13 files changed

Lines changed: 699 additions & 652 deletions

File tree

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,15 @@ rdc close
3333

3434
```bash
3535
uv tool install rdc-cli # or: pipx install rdc-cli
36-
bash <(curl -fsSL https://raw.githubusercontent.com/BANANASJIM/rdc-cli/master/scripts/build-renderdoc.sh)
36+
rdc setup-renderdoc # build renderdoc Python module from source
3737
rdc doctor # verify everything works
3838
```
3939

4040
**PyPI — Windows** (requires git, uv, Visual Studio Build Tools)
4141

4242
```bash
4343
uv tool install rdc-cli # or: pipx install rdc-cli
44-
git clone --depth 1 https://github.com/BANANASJIM/rdc-cli.git rdc-cli
45-
uv run rdc-cli\scripts\build_renderdoc.py
44+
rdc setup-renderdoc # build renderdoc Python module from source
4645
rdc doctor # verify everything works
4746
```
4847

@@ -81,17 +80,10 @@ pixi run setup-renderdoc # build renderdoc (pixi installs toolchain
8180

8281
### RenderDoc bootstrap
8382

84-
**Linux** (one-liner, no repo clone needed):
83+
After installing rdc-cli, build the renderdoc Python module:
8584

8685
```bash
87-
bash <(curl -fsSL https://raw.githubusercontent.com/BANANASJIM/rdc-cli/master/scripts/build-renderdoc.sh)
88-
```
89-
90-
**Windows** (requires git, uv, Visual Studio 2022 Build Tools with C++ workload):
91-
92-
```bash
93-
git clone --depth 1 https://github.com/BANANASJIM/rdc-cli.git rdc-cli
94-
uv run rdc-cli\scripts\build_renderdoc.py
86+
rdc setup-renderdoc
9587
```
9688

9789
If building from source, use the pixi wrapper instead: `pixi run setup-renderdoc`

docs-astro/src/data/commands.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,12 @@
497497
"id": "install-skill",
498498
"help": "Install rdc-cli skill files to ~/.claude/skills/rdc-cli/.",
499499
"usage": "rdc install-skill [--check] [--remove]"
500+
},
501+
{
502+
"name": "setup-renderdoc",
503+
"id": "setup-renderdoc",
504+
"help": "Build and install the renderdoc Python module from source.",
505+
"usage": "rdc setup-renderdoc [INSTALL-DIR] [--build-dir TEXT] [--version TEXT] [--jobs INTEGER]"
500506
}
501507
]
502508
}

docs-astro/src/pages/docs/install.astro

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -83,20 +83,9 @@ rdc open --connect host:54321 --token TOKEN</code></pre>
8383

8484
<h3>Bootstrap (Recommended)</h3>
8585
<p>
86-
<strong>Linux</strong> one-liner (no repo clone needed):
86+
After installing rdc-cli, build the renderdoc Python module:
8787
</p>
88-
<pre><code>bash &lt;(curl -fsSL https://raw.githubusercontent.com/BANANASJIM/rdc-cli/master/scripts/build-renderdoc.sh)</code></pre>
89-
90-
<p>
91-
<strong>Windows</strong> (requires git, uv, Visual Studio 2022 Build Tools with C++ workload):
92-
</p>
93-
<pre><code>git clone --depth 1 https://github.com/BANANASJIM/rdc-cli.git rdc-cli
94-
uv run rdc-cli\scripts\build_renderdoc.py</code></pre>
95-
96-
<p>
97-
If you are building from source, use the pixi wrapper task:
98-
</p>
99-
<pre><code>pixi run setup-renderdoc</code></pre>
88+
<pre><code>rdc setup-renderdoc</code></pre>
10089

10190
<h3>Building Manually</h3>
10291
<pre><code>git clone --depth 1 https://github.com/baldurk/renderdoc.git

0 commit comments

Comments
 (0)