Skip to content

Commit 4df820f

Browse files
Recommend global plugin installation
1 parent 9667b0b commit 4df820f

3 files changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@ plugins/remote-ssh
1313
Install the plugin directly:
1414

1515
```bash
16-
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh/plugins/remote-ssh --plugin
16+
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh/plugins/remote-ssh --plugin --global
1717
```
1818

19+
Global installation is recommended so the plugin appears across Codex projects after restart. For a single project, use `--project` instead of `--global`.
20+
1921
Or install from the repository catalog:
2022

2123
```bash
22-
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins
24+
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins --global
2325
```
2426

2527
See [plugins/remote-ssh/README.md](./plugins/remote-ssh/README.md) for setup, security, and development details.

plugins/remote-ssh/PUBLISHING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,17 @@ plugins/remote-ssh/.codex-plugin/plugin.json
3636
Install command format once published from GitHub:
3737

3838
```bash
39-
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh/plugins/remote-ssh --plugin
39+
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh/plugins/remote-ssh --plugin --global
4040
```
4141

4242
Catalog install command:
4343

4444
```bash
45-
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins
45+
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins --global
4646
```
4747

48+
Use `--project` instead of `--global` when documenting a single-workspace install.
49+
4850
## GitHub Packages
4951

5052
The package name is:

plugins/remote-ssh/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,16 @@ This plugin exposes clear tools for common remote work:
3838
When published to GitHub:
3939

4040
```bash
41-
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh/plugins/remote-ssh --plugin
41+
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh/plugins/remote-ssh --plugin --global
4242
```
4343

4444
If the repository keeps the included `.agents/plugins/marketplace.json` catalog, users can install all plugins from the repo with:
4545

4646
```bash
47-
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins
47+
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins --global
4848
```
4949

50-
For local development, keep this plugin folder under a repo-level `plugins/remote-ssh` directory and reference it from `.agents/plugins/marketplace.json`.
50+
Global installation is recommended so Remote SSH appears across Codex projects after restart. For local development or one-project installs, use `--project` instead of `--global`.
5151

5252
## Configuration
5353

0 commit comments

Comments
 (0)