Skip to content

docs: add usage section to README #11

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.

Sign up for GitHub

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

Merged
preved911 merged 3 commits into from
Jul 27, 2026
Merged

docs: add usage section to README #11

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5bcc2c
docs: add usage section to README
preved911 Jul 27, 2026
e1fa985
Merge branch 'main' into test-inline-review
preved911 Jul 27, 2026
7e5f1b3
Merge branch 'main' into test-inline-review
preved911 Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,11 @@ All tests are in `src/__tests__/`. Run `npm run test:watch` during development.
- **Not a sandbox**: Focused on chain-splitting with path awareness, not comprehensive shell obfuscation detection. For full isolation, pair with a sandbox solution.


@github-actions github-actions Bot Jul 27, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This usage section is a great addition! Would it be helpful to add a brief description of what the plugin does before jumping into the example?


## Usage

@github-actions github-actions Bot Jul 27, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JSON snippet looks good. If you could provide an example of what the complete opencode.json file might look like with this plugin included, it could help new users even more!


Add to your `opencode.json`:

```json
{"plugin": ["opencode-bash-guard"]}
```
Loading