You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`README.md`| "Built With Agents" section, "Explore with your agent" skill references|
17
+
|`README.md`| "Use OpenShell with Your Agent" and "Built With Agents" sections|
18
18
|`.github/ISSUE_TEMPLATE/bug_report.yml`| Skill name references in diagnostic guidance |
19
19
|`.github/ISSUE_TEMPLATE/feature_request.yml`| Skill name references in investigation guidance |
20
20
|`.github/ISSUE_TEMPLATE/config.yml`| Contact link text referencing skills |
@@ -150,7 +150,7 @@ For each file in the table above, check for the following inconsistencies:
150
150
3.**Unique names** — Parse the `name` field from every `SKILL.md` under both roots. Every name must be globally unique and match the documented inventory.
151
151
4.**Local references** — Every relative Markdown link and referenced file in a skill must resolve within that installed skill directory unless the reference is an explicit published URL.
152
152
5.**Canonical paths** — Contributor skills that name the source location of a public skill must use `skills/<name>/...`, never `.agents/skills/<name>/...`.
153
-
6.**Public portability** — Public skills must not require repository-relative files under `docs/`, `architecture/`, `crates/`, `deploy/`, or `.agents/`; source builds; `mise`; or repository E2E workflows. Use installed `openshell --help` for command syntax and `https://docs.nvidia.com/openshell/latest/`links for product documentation.
153
+
6.**Public portability** — Public skills must not require repository-relative files under `docs/`, `architecture/`, `crates/`, `deploy/`, or `.agents/`; source builds; `mise`; or repository E2E workflows. Use installed `openshell --help` for command syntax and Markdown endpoints under `https://docs.nvidia.com/openshell/latest/`(URLs ending in `.md`) for product documentation.
154
154
7.**No canonical documentation copies** — Review public reference files and large command/schema blocks. Remove material that merely copies CLI help, policy schemas, architecture docs, or published operational documentation; retain only skill-specific reasoning and worked interactions.
155
155
8.**Discovery** — Run `npx -y skills add . --list` from a clean checkout or disposable copy. It must list exactly the four public skills. Remove any generated lock file or installed directory after the check.
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@
16
16
17
17
OpenShell is the safe, private runtime for autonomous AI agents. It provides sandboxed execution environments that protect your data, credentials, and infrastructure — governed by declarative YAML policies that prevent unauthorized file access, data exfiltration, and uncontrolled network activity.
18
18
19
-
OpenShell is built agent-first. The project ships with agent skills for everything from gateway troubleshooting to policy generation, and we expect contributors to use them.
19
+
OpenShell is built agent-first. It ships public agent skills for using and operating OpenShell, plus separate repository-aware workflows for contributors and maintainers.
20
20
21
21
## Quickstart
22
22
@@ -225,7 +225,7 @@ OpenShell is developed using the same agent-driven workflows it enables. Contrib
225
225
-**Security review:**`review-security-issue` produces a severity assessment and remediation plan. `fix-security-issue` implements it.
226
226
-**Repository maintenance:**`sync-agent-infra`, `update-docs-from-commits`, and other internal workflows keep code, documentation, and agent infrastructure consistent.
227
227
228
-
All agent implementation work is human-gated: maintainers explicitly request a plan, agents propose it, maintainers approve it, and agents build. See [AGENTS.md](AGENTS.md) for the full workflow chain documentation.
228
+
Agent implementation is human-directed: a user may request a phase directly, or maintainers may use the optional `agent:*` workflow to queue and approve planning and implementation. See [AGENTS.md](AGENTS.md) for the full workflow chain documentation.
229
229
230
230
## Getting Help
231
231
@@ -248,7 +248,7 @@ All agent implementation work is human-gated: maintainers explicitly request a p
248
248
249
249
## Contributing
250
250
251
-
OpenShell is built agent-first. Issues should include a user story, problem statement, impact, and acceptance criteria. The impact should explain the consequences of the current behavior and why existing workarounds are insufficient. Feature requests also require a workflow-level proposed design and alternatives; bug reports add reproduction steps, environment details, and relevant logs. Once maintainers accept work, contributors should use the skills in `.agents/skills/` to investigate the current code and behavior, implement the change, and verify it. If an issue contains earlier diagnostics, verify them rather than relying on them. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full agent skills table, contribution workflow, and development setup.
251
+
OpenShell is built agent-first. Issues should include a user story, problem statement, impact, and acceptance criteria. The impact should explain the consequences of the current behavior and why existing workarounds are insufficient. Feature requests also require a workflow-level proposed design and alternatives; bug reports add reproduction steps, environment details, and relevant logs. Once work is authorized through the project workflow or a direct request, contributors should use the skills in `.agents/skills/` to investigate the current code and behavior, implement the change, and verify it. If an issue contains earlier diagnostics, verify them rather than relying on them. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full agent skills table, contribution workflow, and development setup.
Copy file name to clipboardExpand all lines: skills/debug-openshell-cluster/SKILL.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Use `openshell` first to identify the active endpoint. Then use the platform too
13
13
14
14
The target deployment flow is:
15
15
16
-
1. Operator starts or deploys the gateway with system packages, systemd, Helm, or a development task. The CLI does not start, stop, or destroy gateway services.
16
+
1. Operator starts or deploys the gateway with system packages, systemd, or Helm. The CLI does not start, stop, or destroy gateway services.
17
17
2. Operator configures the compute driver.
18
18
3. Operator provides the CLI and supervisor authentication material required by the deployment mode: edge or OIDC user auth, optional CLI mTLS, and gateway-minted sandbox JWTs.
19
19
4. The CLI registers a reachable gateway endpoint with `openshell gateway add`.
@@ -427,17 +427,15 @@ kubectl -n openshell get endpoints openshell
Copy file name to clipboardExpand all lines: skills/generate-sandbox-policy/SKILL.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ The user provides full API documentation. Accepted formats:
64
64
65
65
| Format | How to consume |
66
66
|--------|----------------|
67
-
|**URL**| Fetch with `WebFetch` and parse the endpoint list |
67
+
|**URL**| Fetch with the agent's web access and parse the endpoint list |
68
68
|**File path**| Read the file (OpenAPI JSON/YAML, markdown, etc.) |
69
69
|**Pasted text**| Parse inline from the conversation |
70
70
|**OpenAPI/Swagger spec**| Extract `paths` object for all method+path combinations |
@@ -128,9 +128,9 @@ When the user mentions a recognizable API host but hasn't provided docs, and the
128
128
**How to do it:**
129
129
1. Tell the user: "I can look up the REST API docs for [service] to help generate a more precise policy. Want me to do that?"
130
130
2. If the user agrees (or hasn't declined), search for the docs:
131
-
-Use `WebSearch` with a query like `"[service name] REST API documentation endpoints"` or `"[service name] OpenAPI spec"`
131
+
-Search the web with a query like `"[service name] REST API documentation endpoints"` or `"[service name] OpenAPI spec"`
132
132
- Look for official documentation URLs in the results
133
-
3. Fetch the docs page with `WebFetch` and extract the endpoint inventory (method + path pairs)
133
+
3. Fetch the documentation page and extract the endpoint inventory (method + path pairs)
134
134
4. Use the discovered endpoints to offer tighter scoping: "I found [N] endpoints in the [service] API. Based on your intent, I can narrow the policy to just [subset]. Want me to do that, or keep the broader preset?"
Copy file name to clipboardExpand all lines: skills/generate-sandbox-policy/examples.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,8 +138,8 @@ Same preset applied to multiple hosts in one policy because the binary set is th
138
138
1. Recognize `api.openai.com` as a well-known service
139
139
2. Ask: "I can look up OpenAI's REST API docs to generate a more precise policy. Want me to do that, or should I use a broad preset?"
140
140
3. User says: "Yeah go ahead"
141
-
4. `WebSearch` for "OpenAI REST API documentation endpoints"
142
-
5. `WebFetch` the docs page, extract endpoints:
141
+
4. Search the web for "OpenAI REST API documentation endpoints"
142
+
5. Fetch the documentation page and extract endpoints:
143
143
- `POST /v1/chat/completions`
144
144
- `POST /v1/embeddings`
145
145
- `GET /v1/models`
@@ -748,7 +748,7 @@ An exact IP is treated as `/32` — only that specific address is permitted.
748
748
- { path: /usr/bin/curl }
749
749
```
750
750
751
-
The agent uses `StrReplace` to insert after the last existing policy in the `network_policies` block. All other sections (`filesystem_policy`, `landlock`, `process`) are untouched.
751
+
The agent inserts the new entry after the last existing policy in the `network_policies` block. All other sections (`filesystem_policy`, `landlock`, `process`) are untouched.
Copy file name to clipboardExpand all lines: skills/openshell-cli/SKILL.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Guide agents through using the `openshell` CLI for sandbox and platform manageme
9
9
10
10
## Overview
11
11
12
-
The OpenShell CLI (`openshell`) is the primary interface for managing sandboxes, providers, policies, settings, exposed services, inference routes, and gateway registrations. Gateway service lifecycle is handled outside the CLI by packages, systemd, Helm, or development tasks. This skill teaches agents how to orchestrate CLI commands for common and complex workflows.
12
+
The OpenShell CLI (`openshell`) is the primary interface for managing sandboxes, providers, policies, settings, exposed services, inference routes, and gateway registrations. Gateway service lifecycle is handled outside the CLI by packages, systemd, or Helm. This skill teaches agents how to orchestrate CLI commands for common and complex workflows.
13
13
14
14
**Companion skill**: For creating or modifying sandbox policy YAML content (network rules, L7 inspection, access presets), use the `generate-sandbox-policy` skill. This skill covers the CLI *commands* for the policy lifecycle; `generate-sandbox-policy` covers policy *content authoring*.
0 commit comments