Skip to content

Commit f5b7d31

Browse files
Update ToolHive reference docs for v0.2.2 (#83)
* Update ToolHive reference docs for v0.2.2 * Fix broken links Signed-off-by: Dan Barr <[email protected]> --------- Signed-off-by: Dan Barr <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Dan Barr <[email protected]>
1 parent 02ab56d commit f5b7d31

File tree

12 files changed

+279
-76
lines changed

12 files changed

+279
-76
lines changed

docs/toolhive/guides-cli/registry.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,6 @@ registry.
193193

194194
- [`thv registry` command reference](../reference/cli/thv_registry.md)
195195
- [`thv search` command reference](../reference/cli/thv_search.md)
196-
- [`thv config set-registry-url` command reference](../reference/cli/thv_config_set-registry-url.md)
197-
- [`thv config get-registry-url` command reference](../reference/cli/thv_config_get-registry-url.md)
198-
- [`thv config unset-registry-url` command reference](../reference/cli/thv_config_unset-registry-url.md)
196+
- [`thv config set-registry-url` command reference](../reference/cli/thv_config_set-registry.md)
197+
- [`thv config get-registry-url` command reference](../reference/cli/thv_config_get-registry.md)
198+
- [`thv config unset-registry-url` command reference](../reference/cli/thv_config_unset-registry.md)

docs/toolhive/reference/cli/thv.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ thv [flags]
4848
* [thv rm](thv_rm.md) - Remove an MCP server
4949
* [thv run](thv_run.md) - Run an MCP server
5050
* [thv runtime](thv_runtime.md) - Commands related to the container runtime
51-
* [thv runtime](thv_runtime.md) - Commands related to the container runtime
5251
* [thv search](thv_search.md) - Search for MCP servers
5352
* [thv secret](thv_secret.md) - Manage secrets
5453
* [thv serve](thv_serve.md) - Start the ToolHive API server

docs/toolhive/reference/cli/thv_client_register.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ Register a client for MCP server configuration
1818
Register a client for MCP server configuration.
1919

2020
Valid clients:
21+
- amp-cli: Sourcegraph Amp CLI
22+
- amp-cursor: Sourcegraph Amp extension for Cursor
23+
- amp-vscode: Sourcegraph Amp extension for VS Code
24+
- amp-vscode-insider: Sourcegraph Amp extension for VS Code Insiders
25+
- amp-windsurf: Sourcegraph Amp extension for Windsurf
2126
- claude-code: Claude Code CLI
2227
- cline: Cline extension for VS Code
2328
- cursor: Cursor editor

docs/toolhive/reference/cli/thv_client_remove.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ Remove a client from MCP server configuration
1818
Remove a client from MCP server configuration.
1919

2020
Valid clients:
21+
- amp-cli: Sourcegraph Amp CLI
22+
- amp-cursor: Sourcegraph Amp extension for Cursor
23+
- amp-vscode: Sourcegraph Amp extension for VS Code
24+
- amp-vscode-insider: Sourcegraph Amp extension for VS Code Insiders
25+
- amp-windsurf: Sourcegraph Amp extension for Windsurf
2126
- claude-code: Claude Code CLI
2227
- cline: Cline extension for VS Code
2328
- cursor: Cursor editor

docs/toolhive/reference/cli/thv_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ The config command provides subcommands to manage application configuration sett
3333

3434
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
3535
* [thv config get-ca-cert](thv_config_get-ca-cert.md) - Get the currently configured CA certificate path
36-
* [thv config get-registry-url](thv_config_get-registry-url.md) - Get the currently configured registry URL
36+
* [thv config get-registry](thv_config_get-registry.md) - Get the currently configured registry
3737
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
3838
* [thv config set-ca-cert](thv_config_set-ca-cert.md) - Set the default CA certificate for container builds
39-
* [thv config set-registry-url](thv_config_set-registry-url.md) - Set the MCP server registry URL
39+
* [thv config set-registry](thv_config_set-registry.md) - Set the MCP server registry
4040
* [thv config unset-ca-cert](thv_config_unset-ca-cert.md) - Remove the configured CA certificate
41-
* [thv config unset-registry-url](thv_config_unset-registry-url.md) - Remove the configured registry URL
41+
* [thv config unset-registry](thv_config_unset-registry.md) - Remove the configured registry
4242

docs/toolhive/reference/cli/thv_config_get-registry-url.md renamed to docs/toolhive/reference/cli/thv_config_get-registry.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
---
2-
title: thv config get-registry-url
2+
title: thv config get-registry
33
hide_title: true
4-
description: Reference for ToolHive CLI command `thv config get-registry-url`
4+
description: Reference for ToolHive CLI command `thv config get-registry`
55
last_update:
66
author: autogenerated
7-
slug: thv_config_get-registry-url
7+
slug: thv_config_get-registry
88
mdx:
99
format: md
1010
---
1111

12-
## thv config get-registry-url
12+
## thv config get-registry
1313

14-
Get the currently configured registry URL
14+
Get the currently configured registry
1515

1616
### Synopsis
1717

18-
Display the URL of the remote registry that is currently configured.
18+
Display the currently configured registry (URL or file path).
1919

2020
```
21-
thv config get-registry-url [flags]
21+
thv config get-registry [flags]
2222
```
2323

2424
### Options
2525

2626
```
27-
-h, --help help for get-registry-url
27+
-h, --help help for get-registry
2828
```
2929

3030
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_config_set-registry-url.md

Lines changed: 0 additions & 44 deletions
This file was deleted.
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: thv config set-registry
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv config set-registry`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_config_set-registry
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv config set-registry
13+
14+
Set the MCP server registry
15+
16+
### Synopsis
17+
18+
Set the MCP server registry to either a remote URL or local file path.
19+
The command automatically detects whether the input is a URL or file path.
20+
21+
Examples:
22+
thv config set-registry https://example.com/registry.json # Remote URL
23+
thv config set-registry /path/to/local-registry.json # Local file path
24+
thv config set-registry file:///path/to/local-registry.json # Explicit file URL
25+
26+
```
27+
thv config set-registry <url-or-path> [flags]
28+
```
29+
30+
### Options
31+
32+
```
33+
-p, --allow-private-ip Allow setting the registry URL, even if it references a private IP address
34+
-h, --help help for set-registry
35+
```
36+
37+
### Options inherited from parent commands
38+
39+
```
40+
--debug Enable debug mode
41+
```
42+
43+
### SEE ALSO
44+
45+
* [thv config](thv_config.md) - Manage application configuration
46+

docs/toolhive/reference/cli/thv_config_unset-registry-url.md renamed to docs/toolhive/reference/cli/thv_config_unset-registry.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
---
2-
title: thv config unset-registry-url
2+
title: thv config unset-registry
33
hide_title: true
4-
description: Reference for ToolHive CLI command `thv config unset-registry-url`
4+
description: Reference for ToolHive CLI command `thv config unset-registry`
55
last_update:
66
author: autogenerated
7-
slug: thv_config_unset-registry-url
7+
slug: thv_config_unset-registry
88
mdx:
99
format: md
1010
---
1111

12-
## thv config unset-registry-url
12+
## thv config unset-registry
1313

14-
Remove the configured registry URL
14+
Remove the configured registry
1515

1616
### Synopsis
1717

18-
Remove the registry URL configuration, reverting to the built-in registry.
18+
Remove the registry configuration, reverting to the built-in registry.
1919

2020
```
21-
thv config unset-registry-url [flags]
21+
thv config unset-registry [flags]
2222
```
2323

2424
### Options
2525

2626
```
27-
-h, --help help for unset-registry-url
27+
-h, --help help for unset-registry
2828
```
2929

3030
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_logs.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Output the logs of an MCP server or manage log files
1717

1818
Output the logs of an MCP server managed by ToolHive, or manage log files.
1919

20+
By default, this command shows the logs from the MCP server container.
21+
Use --proxy to view the logs from the ToolHive proxy process instead.
22+
2023
```
2124
thv logs [workload-name|prune] [flags]
2225
```
@@ -26,6 +29,7 @@ thv logs [workload-name|prune] [flags]
2629
```
2730
-f, --follow Follow log output (only for workload logs)
2831
-h, --help help for logs
32+
-p, --proxy Show proxy logs instead of container logs
2933
```
3034

3135
### Options inherited from parent commands

0 commit comments

Comments
 (0)