-
Notifications
You must be signed in to change notification settings - Fork 2
Update docs for run --from-config #163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: lujunsan <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation to reflect recent changes to the thv run --from-config command behavior. The changes clarify that using --from-config creates persistent workloads rather than temporary ones, and adds restrictions on flag usage with this option.
Key changes:
- Updated behavior description for
--from-configto emphasize persistent workload creation - Added restriction that
--from-configcannot be used with other flags - Enhanced explanations across CLI reference and user guide documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/toolhive/reference/cli/thv_run.md | Added details about persistent workload creation and flag restrictions for --from-config |
| docs/toolhive/reference/cli/thv_export.md | Updated description to clarify exported configs create persistent, manageable workloads |
| docs/toolhive/guides-cli/run-mcp-servers.mdx | Enhanced explanation of --from-config behavior and added note about flag restrictions |
Signed-off-by: lujunsan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lujunsan the reference/cli docs will get copied over via an automated PR when the next release gets cut. You might want to drop your changes from this PR to avoid a potential conflict?
| the original server used secrets, you must have the same secrets available in | ||
| your ToolHive secrets store. | ||
| This creates a persistent server instance with identical settings to the | ||
| original and saves a real configuration file. The server can be stopped, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what "and saves a real configuration" file means here. If you mean the runconfig, I think that's a bit of an internal plumbing thing that the user doesn't really need to know/care about?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @lujunsan just wanted to make sure you saw this question and the comment above about the auto-update of the cli reference docs? Anything you need from me to help clarify this?
Signed-off-by: Dan Barr <[email protected]>
Adding updated docs related with the recent
thv run --from-configchanges