Skip to content

Commit 234dacc

Browse files
Document plugin visibility troubleshooting
1 parent 4df820f commit 234dacc

3 files changed

Lines changed: 65 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,31 @@ npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins --globa
2626

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

29+
## Troubleshooting Visibility
30+
31+
After global install, restart Codex. If Remote SSH still does not appear in the plugin UI, confirm that `~/.codex/config.toml` includes both the plugin entry and the marketplace source:
32+
33+
```toml
34+
[plugins."remote-ssh@codex-marketplace-global"]
35+
enabled = true
36+
37+
[marketplaces.codex-marketplace-global]
38+
source_type = "local"
39+
source = '\\?\C:\Users\<you>'
40+
```
41+
42+
The global marketplace manifest should exist at:
43+
44+
```text
45+
~/.agents/plugins/marketplace.json
46+
```
47+
48+
The installed plugin should exist at:
49+
50+
```text
51+
~/.codex/plugins/remote-ssh
52+
```
53+
2954
## Repository Documents
3055

3156
- [License](./LICENSE)

plugins/remote-ssh/PUBLISHING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,26 @@ npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins --globa
4747

4848
Use `--project` instead of `--global` when documenting a single-workspace install.
4949

50+
## Visibility Troubleshooting
51+
52+
If a global install succeeds but the plugin does not appear in Codex after restart, confirm `~/.codex/config.toml` has:
53+
54+
```toml
55+
[plugins."remote-ssh@codex-marketplace-global"]
56+
enabled = true
57+
58+
[marketplaces.codex-marketplace-global]
59+
source_type = "local"
60+
source = '\\?\C:\Users\<you>'
61+
```
62+
63+
Then confirm:
64+
65+
```text
66+
~/.agents/plugins/marketplace.json
67+
~/.codex/plugins/remote-ssh
68+
```
69+
5070
## GitHub Packages
5171

5272
The package name is:

plugins/remote-ssh/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,26 @@ npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins --globa
4949

5050
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

52+
## Troubleshooting Visibility
53+
54+
After installing globally, restart Codex. If Remote SSH is enabled but still not visible, confirm that `~/.codex/config.toml` includes both entries:
55+
56+
```toml
57+
[plugins."remote-ssh@codex-marketplace-global"]
58+
enabled = true
59+
60+
[marketplaces.codex-marketplace-global]
61+
source_type = "local"
62+
source = '\\?\C:\Users\<you>'
63+
```
64+
65+
Also confirm the global marketplace and plugin paths exist:
66+
67+
```text
68+
~/.agents/plugins/marketplace.json
69+
~/.codex/plugins/remote-ssh
70+
```
71+
5272
## Configuration
5373

5474
Most users should add connections conversationally:

0 commit comments

Comments
 (0)