diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-06-15 19:02:40 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-06-15 19:03:24 +0300 |
| commit | befe629312d9ddf0fea91d1c70f1e4c69afeaf76 (patch) | |
| tree | d076758594991240682ef5ab28ccfc563a4edd3a /docs/next/website/src/content | |
| parent | 99bf8dadeb03afcee6f1d0ff3af9b6f174a422f9 (diff) | |
docs: finalize 0.7.0 release docs
Diffstat (limited to 'docs/next/website/src/content')
| -rw-r--r-- | docs/next/website/src/content/docs/cli-reference.mdx | 8 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/plugins.mdx | 17 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/socket-api.mdx | 2 |
3 files changed, 18 insertions, 9 deletions
diff --git a/docs/next/website/src/content/docs/cli-reference.mdx b/docs/next/website/src/content/docs/cli-reference.mdx index 99f1faae..f1079995 100644 --- a/docs/next/website/src/content/docs/cli-reference.mdx +++ b/docs/next/website/src/content/docs/cli-reference.mdx @@ -302,6 +302,14 @@ herdr plugin unlink <plugin_id> `plugin link` accepts a plugin directory containing `herdr-plugin.toml` or a direct manifest path. It is still the right command while authoring or testing a plugin from a local checkout. `plugin unlink` unregisters the plugin and leaves files alone. `plugin uninstall` unregisters a plugin and also removes Herdr-managed GitHub checkout files. For GitHub installs, uninstall accepts either the plugin id or the same `owner/repo[/subdir...]` shorthand used by install. Actions, event hooks, panes, and link handlers are declared in the manifest; runtime action registration is not part of v1. +Config directory: + +```bash +herdr plugin config-dir <plugin_id> +``` + +`plugin config-dir` prints the plugin's config directory, creating it (and seeding it from legacy plugin config locations when present) if needed. Use it in setup docs and shell scripts to point users at a stable path for `.env` files and other user-editable config, separate from the managed plugin checkout. + Actions: ```bash diff --git a/docs/next/website/src/content/docs/plugins.mdx b/docs/next/website/src/content/docs/plugins.mdx index 5dcd50ab..09d89bc0 100644 --- a/docs/next/website/src/content/docs/plugins.mdx +++ b/docs/next/website/src/content/docs/plugins.mdx @@ -21,12 +21,13 @@ manifest, injects runtime context, starts the declared commands, and records logs. The commands call back into Herdr through the CLI or socket when they need to do more work. -Most plugins should call Herdr through `HERDR_BIN_PATH`, which points at the -running Herdr binary. That keeps plugins portable across Unix sockets and -Windows named pipes. Use the [CLI reference](/docs/cli-reference/) as the -catalog of commands a plugin can call. Use the -[socket API](/docs/socket-api/) when you want to send raw JSON requests -yourself. +There is no separate plugin SDK or restricted command set. The entire Herdr CLI +is the plugin API: every command in the [CLI reference](/docs/cli-reference/) is +available to a plugin, and anything you can run as `herdr ...` yourself a plugin +can run too. Most plugins should call Herdr through `HERDR_BIN_PATH`, which +points at the running Herdr binary. That keeps plugins portable across Unix +sockets and Windows named pipes. Use the [socket API](/docs/socket-api/) when +you want to send raw JSON requests yourself. Runtime action registration and native non-terminal plugin UI are not part of plugin v1. Actions, event hooks, panes, and link handlers are all declared in @@ -42,7 +43,7 @@ Herdr can run. id = "example.layout" name = "Layout" version = "0.1.0" -min_herdr_version = "0.6.10" +min_herdr_version = "0.7.0" description = "Apply project layouts" platforms = ["linux", "macos", "windows"] @@ -112,7 +113,7 @@ my-plugin/ id = "example.workspace-tools" name = "Workspace Tools" version = "0.1.0" -min_herdr_version = "0.6.10" +min_herdr_version = "0.7.0" description = "Small workspace helpers" platforms = ["linux", "macos", "windows"] diff --git a/docs/next/website/src/content/docs/socket-api.mdx b/docs/next/website/src/content/docs/socket-api.mdx index 88280441..74697fd8 100644 --- a/docs/next/website/src/content/docs/socket-api.mdx +++ b/docs/next/website/src/content/docs/socket-api.mdx @@ -329,7 +329,7 @@ manifest path. The manifest shape is: id = "example.worktree-bootstrap" name = "Worktree Bootstrap" version = "0.1.0" -min_herdr_version = "0.6.10" +min_herdr_version = "0.7.0" description = "Prepare new worktrees" platforms = ["linux", "macos", "windows"] |
