sqube-agent-guard 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. sqube_agent_guard-0.1.0/.env.example +10 -0
  2. sqube_agent_guard-0.1.0/.github/workflows/ci.yml +46 -0
  3. sqube_agent_guard-0.1.0/.github/workflows/docs.yml +53 -0
  4. sqube_agent_guard-0.1.0/.github/workflows/release.yml +72 -0
  5. sqube_agent_guard-0.1.0/.gitignore +43 -0
  6. sqube_agent_guard-0.1.0/LICENSE +201 -0
  7. sqube_agent_guard-0.1.0/PKG-INFO +202 -0
  8. sqube_agent_guard-0.1.0/README.md +179 -0
  9. sqube_agent_guard-0.1.0/examples/nvidia_kimi_vision_probe.py +159 -0
  10. sqube_agent_guard-0.1.0/examples/python_db_mutation.py +44 -0
  11. sqube_agent_guard-0.1.0/examples/python_file_delete.py +38 -0
  12. sqube_agent_guard-0.1.0/examples/python_send_email.py +28 -0
  13. sqube_agent_guard-0.1.0/nodejs/package-lock.json +472 -0
  14. sqube_agent_guard-0.1.0/nodejs/package.json +45 -0
  15. sqube_agent_guard-0.1.0/nodejs/src/approval.ts +49 -0
  16. sqube_agent_guard-0.1.0/nodejs/src/errors.ts +26 -0
  17. sqube_agent_guard-0.1.0/nodejs/src/guard.test.ts +108 -0
  18. sqube_agent_guard-0.1.0/nodejs/src/guard.ts +220 -0
  19. sqube_agent_guard-0.1.0/nodejs/src/index.ts +9 -0
  20. sqube_agent_guard-0.1.0/nodejs/src/ledger.ts +82 -0
  21. sqube_agent_guard-0.1.0/nodejs/src/policy.ts +13 -0
  22. sqube_agent_guard-0.1.0/nodejs/src/redaction.ts +34 -0
  23. sqube_agent_guard-0.1.0/nodejs/src/types.ts +56 -0
  24. sqube_agent_guard-0.1.0/nodejs/tsconfig.json +13 -0
  25. sqube_agent_guard-0.1.0/pyproject.toml +40 -0
  26. sqube_agent_guard-0.1.0/rust/Cargo.lock +727 -0
  27. sqube_agent_guard-0.1.0/rust/Cargo.toml +25 -0
  28. sqube_agent_guard-0.1.0/rust/README.md +41 -0
  29. sqube_agent_guard-0.1.0/rust/src/approval.rs +31 -0
  30. sqube_agent_guard-0.1.0/rust/src/error.rs +19 -0
  31. sqube_agent_guard-0.1.0/rust/src/guard.rs +339 -0
  32. sqube_agent_guard-0.1.0/rust/src/ledger.rs +166 -0
  33. sqube_agent_guard-0.1.0/rust/src/lib.rs +13 -0
  34. sqube_agent_guard-0.1.0/rust/src/models.rs +71 -0
  35. sqube_agent_guard-0.1.0/rust/src/policy.rs +17 -0
  36. sqube_agent_guard-0.1.0/rust/src/redaction.rs +29 -0
  37. sqube_agent_guard-0.1.0/src/sqube_agent_guard/__init__.py +5 -0
  38. sqube_agent_guard-0.1.0/src/sqube_agent_guard/approval.py +57 -0
  39. sqube_agent_guard-0.1.0/src/sqube_agent_guard/cli.py +45 -0
  40. sqube_agent_guard-0.1.0/src/sqube_agent_guard/exceptions.py +20 -0
  41. sqube_agent_guard-0.1.0/src/sqube_agent_guard/guard.py +231 -0
  42. sqube_agent_guard-0.1.0/src/sqube_agent_guard/ledger.py +75 -0
  43. sqube_agent_guard-0.1.0/src/sqube_agent_guard/models.py +48 -0
  44. sqube_agent_guard-0.1.0/src/sqube_agent_guard/policy.py +13 -0
  45. sqube_agent_guard-0.1.0/src/sqube_agent_guard/redaction.py +32 -0
  46. sqube_agent_guard-0.1.0/tests/test_guard.py +223 -0
  47. sqube_agent_guard-0.1.0/tests/test_redaction.py +5 -0
  48. sqube_agent_guard-0.1.0/website/babel.config.js +3 -0
  49. sqube_agent_guard-0.1.0/website/docs/deploy-pages.md +78 -0
  50. sqube_agent_guard-0.1.0/website/docs/intro.md +47 -0
  51. sqube_agent_guard-0.1.0/website/docs/optional-llm-probes.md +34 -0
  52. sqube_agent_guard-0.1.0/website/docs/v0.1-spec.md +488 -0
  53. sqube_agent_guard-0.1.0/website/docusaurus.config.js +59 -0
  54. sqube_agent_guard-0.1.0/website/package-lock.json +17318 -0
  55. sqube_agent_guard-0.1.0/website/package.json +43 -0
  56. sqube_agent_guard-0.1.0/website/sidebars.js +6 -0
  57. sqube_agent_guard-0.1.0/website/src/css/custom.css +9 -0
  58. sqube_agent_guard-0.1.0/website/src/pages/index.js +5 -0
  59. sqube_agent_guard-0.1.0/website/static/.gitkeep +0 -0
@@ -0,0 +1,10 @@
1
+ # `.env` is local-only; never commit. Copy to `.env` and edit locally. Used by optional probe scripts only.
2
+ #
3
+ # In a .env file, quotes are optional (some loaders keep quotes in the value):
4
+ # NVIDIA_API_KEY=nvapi-your-key-here
5
+ # NVIDIA_API_KEY="nvapi-your-key-here"
6
+ #
7
+ # In your shell, use quotes around the value:
8
+ # export NVIDIA_API_KEY="nvapi-your-key-here"
9
+ #
10
+ NVIDIA_API_KEY="nvapi-your-key-here"
@@ -0,0 +1,46 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ jobs:
10
+ python:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/checkout@v4
14
+ - uses: actions/setup-python@v5
15
+ with:
16
+ python-version: "3.12"
17
+ - name: Install dev deps
18
+ run: pip install -e ".[dev]"
19
+ - name: Pytest
20
+ run: pytest
21
+
22
+ node:
23
+ runs-on: ubuntu-latest
24
+ defaults:
25
+ run:
26
+ working-directory: nodejs
27
+ steps:
28
+ - uses: actions/checkout@v4
29
+ - uses: actions/setup-node@v4
30
+ with:
31
+ node-version: "20"
32
+ - name: Install and test
33
+ run: |
34
+ npm ci
35
+ npm test
36
+
37
+ rust:
38
+ runs-on: ubuntu-latest
39
+ defaults:
40
+ run:
41
+ working-directory: rust
42
+ steps:
43
+ - uses: actions/checkout@v4
44
+ - uses: dtolnay/rust-toolchain@stable
45
+ - name: Cargo test
46
+ run: cargo test --locked
@@ -0,0 +1,53 @@
1
+ name: Deploy docs to GitHub Pages
2
+
3
+ # Deploys only on pushes to main (not staging, feature branches, or PRs).
4
+
5
+ on:
6
+ push:
7
+ branches: [main]
8
+ paths:
9
+ - "website/**"
10
+ - ".github/workflows/docs.yml"
11
+ workflow_dispatch:
12
+
13
+ permissions:
14
+ contents: read
15
+ pages: write
16
+ id-token: write
17
+
18
+ concurrency:
19
+ group: "pages"
20
+ cancel-in-progress: false
21
+
22
+ jobs:
23
+ build:
24
+ runs-on: ubuntu-latest
25
+ steps:
26
+ - uses: actions/checkout@v4
27
+ - uses: actions/setup-node@v4
28
+ with:
29
+ node-version: "22"
30
+ cache: npm
31
+ cache-dependency-path: website/package-lock.json
32
+ - name: Install dependencies
33
+ working-directory: website
34
+ run: npm ci
35
+ - name: Build Docusaurus site
36
+ working-directory: website
37
+ run: npm run build
38
+ - name: Upload Pages artifact
39
+ uses: actions/upload-pages-artifact@v3
40
+ with:
41
+ path: website/build
42
+
43
+ deploy:
44
+ needs: build
45
+ if: github.ref == 'refs/heads/main'
46
+ runs-on: ubuntu-latest
47
+ environment:
48
+ name: github-pages
49
+ url: ${{ steps.deployment.outputs.page_url }}
50
+ steps:
51
+ - name: Deploy to GitHub Pages
52
+ id: deployment
53
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,72 @@
1
+ name: Release
2
+
3
+ # Publishes to PyPI and npm only when a semver tag (v*.*.*) is pushed and the
4
+ # tagged commit is on main. Tag from main after merge; tags on other branches
5
+ # are rejected by the assert-on-main job.
6
+
7
+ on:
8
+ push:
9
+ tags:
10
+ - "v*.*.*"
11
+
12
+ permissions:
13
+ contents: read
14
+
15
+ jobs:
16
+ assert-on-main:
17
+ runs-on: ubuntu-latest
18
+ steps:
19
+ - uses: actions/checkout@v4
20
+ with:
21
+ fetch-depth: 0
22
+ - name: Verify tagged commit is on main
23
+ run: |
24
+ git fetch origin main
25
+ git merge-base --is-ancestor HEAD origin/main
26
+
27
+ python:
28
+ needs: assert-on-main
29
+ runs-on: ubuntu-latest
30
+ steps:
31
+ - uses: actions/checkout@v4
32
+ - uses: actions/setup-python@v5
33
+ with:
34
+ python-version: "3.12"
35
+ - name: Build wheel and sdist
36
+ run: pip install build && python -m build
37
+ - name: Publish to PyPI
38
+ uses: pypa/gh-action-pypi-publish@release/v1
39
+ with:
40
+ password: ${{ secrets.PYPI_API_TOKEN }}
41
+
42
+ node:
43
+ needs: assert-on-main
44
+ runs-on: ubuntu-latest
45
+ defaults:
46
+ run:
47
+ working-directory: nodejs
48
+ steps:
49
+ - uses: actions/checkout@v4
50
+ - uses: actions/setup-node@v4
51
+ with:
52
+ node-version: "20"
53
+ registry-url: "https://registry.npmjs.org"
54
+ - run: npm ci
55
+ - run: npm run build
56
+ - run: npm publish --access public
57
+ env:
58
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
59
+
60
+ # crates.io publish disabled until a registry account/token is available.
61
+ # rust:
62
+ # runs-on: ubuntu-latest
63
+ # defaults:
64
+ # run:
65
+ # working-directory: rust
66
+ # steps:
67
+ # - uses: actions/checkout@v4
68
+ # - uses: dtolnay/rust-toolchain@stable
69
+ # - uses: katyo/publish-crates-action@v2
70
+ # with:
71
+ # registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
72
+ # path: rust
@@ -0,0 +1,43 @@
1
+ # Python
2
+ .env
3
+ .env.local
4
+ __pycache__/
5
+ *.py[cod]
6
+ .pytest_cache/
7
+ *.egg-info/
8
+ dist/
9
+ build/
10
+ .venv/
11
+ venv/
12
+
13
+ # Node
14
+ nodejs/node_modules/
15
+ nodejs/dist/
16
+
17
+ # Rust
18
+ rust/target/
19
+
20
+ # Ledgers / local artifacts
21
+ *.sqlite3
22
+ examples_ledger.sqlite3
23
+
24
+ # IDE
25
+ .idea/
26
+ .vscode/
27
+ *.swp
28
+
29
+ # OS
30
+ .DS_Store
31
+
32
+ # Internal / local-only docs (never commit)
33
+ docs_internal_never_commit/
34
+ docs-never-commit/
35
+ .local-docs/
36
+ **/never-commit/
37
+ # Legacy spec path (content lives in website/docs/)
38
+ docs/project md files/
39
+
40
+ # Docusaurus
41
+ website/node_modules/
42
+ website/build/
43
+ website/.docusaurus/
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,202 @@
1
+ Metadata-Version: 2.5
2
+ Name: sqube-agent-guard
3
+ Version: 0.1.0
4
+ Summary: Developer-side execution guardrail with decision, optional human pause, and append-only ledger (v0.1 experiment)
5
+ Author: Sqube Groups
6
+ License-Expression: Apache-2.0
7
+ License-File: LICENSE
8
+ Keywords: agents,ai,execution,guardrail,policy
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Requires-Python: >=3.10
17
+ Provides-Extra: dev
18
+ Requires-Dist: pytest>=8.0; extra == 'dev'
19
+ Provides-Extra: probes
20
+ Requires-Dist: python-dotenv>=1.0; extra == 'probes'
21
+ Requires-Dist: requests>=2.31; extra == 'probes'
22
+ Description-Content-Type: text/markdown
23
+
24
+ # Sqube Agent Control
25
+
26
+ > Open-source infrastructure for controlling AI agent actions.
27
+
28
+ **v0.1 is an experiment.** SDK wrapping is bypassable. This is **not** a replacement for IAM, gateways, or security controls. It exists to learn whether execution-decision tooling has pull in real teams.
29
+
30
+ Sqube Execution Guard (v0.1) wraps a consequential action, deterministically decides `ALLOW` / `BLOCK` / `REQUIRE_APPROVAL`, optionally pauses for a human via CLI, and writes an append-only SQLite execution record.
31
+
32
+ Do not use messaging like “secure your agents,” “enterprise control plane,” or “prevent all unauthorized actions.”
33
+
34
+ ## Status
35
+
36
+ **Experimental — API may change.**
37
+
38
+ ## SDKs
39
+
40
+ | Language | Package | Path |
41
+ |----------|---------|------|
42
+ | Python | `sqube-agent-guard` (PyPI) | `src/sqube_agent_guard/` |
43
+ | Node.js | `@sqube/agent-guard` (npm) | `nodejs/` |
44
+ | Rust | `sqube-agent-guard` (build from `rust/`) | `rust/` |
45
+
46
+ All three implement the same v0.1 contract documented on **[GitHub Pages](https://sqube-groups.github.io/sqube-agent-control/docs/v0.1-spec)** (source: [`website/docs/v0.1-spec.md`](website/docs/v0.1-spec.md)).
47
+
48
+ ## Quick start (Python)
49
+
50
+ ```python
51
+ from sqube_agent_guard import ExecutionGuard, Decision
52
+
53
+
54
+ def policy(action, resource, agent_id, **ctx):
55
+ if action == "delete_file":
56
+ return Decision.REQUIRE_APPROVAL
57
+ return Decision.ALLOW
58
+
59
+
60
+ guard = ExecutionGuard(policy=policy)
61
+
62
+
63
+ @guard.wrap_action(action="delete_file", resource=lambda path: f"file:{path}")
64
+ def delete_file(path):
65
+ ...
66
+
67
+
68
+ delete_file("/tmp/example.txt")
69
+ ```
70
+
71
+ ## Quick start (Node.js)
72
+
73
+ ```typescript
74
+ import { Decision, ExecutionGuard } from "@sqube/agent-guard";
75
+
76
+ const guard = new ExecutionGuard({
77
+ policy: (action) =>
78
+ action === "delete_file" ? Decision.REQUIRE_APPROVAL : Decision.ALLOW,
79
+ });
80
+
81
+ const deleteFile = guard.wrapAction(
82
+ { action: "delete_file", resource: (path: string) => `file:${path}` },
83
+ (path: string) => { /* ... */ }
84
+ );
85
+
86
+ await deleteFile("/tmp/example.txt");
87
+ ```
88
+
89
+ ## Quick start (Rust)
90
+
91
+ ```rust
92
+ use sqube_agent_guard::{Decision, ExecutionGuard, WrapOptions};
93
+
94
+ let guard = ExecutionGuard::with_default_policy().with_ledger_path("sqube_ledger.sqlite3");
95
+
96
+ guard.wrap_action(
97
+ WrapOptions {
98
+ action: "delete_file".into(),
99
+ resource: Some("file:/tmp/x".into()),
100
+ agent_id: "default".into(),
101
+ },
102
+ || Ok(()),
103
+ "path=/tmp/x",
104
+ r#"{"path":"/tmp/x"}"#,
105
+ )?;
106
+ ```
107
+
108
+ ## Decisions
109
+
110
+ ```text
111
+ ALLOW
112
+ BLOCK
113
+ REQUIRE_APPROVAL
114
+ ```
115
+
116
+ Policies are application-defined callables. No LLM in the decision path for v0.1.
117
+
118
+ ## Installation
119
+
120
+ **Python and Node.js** (published registries):
121
+
122
+ ```bash
123
+ pip install sqube-agent-guard
124
+ npm install @sqube/agent-guard
125
+ ```
126
+
127
+ **Rust** — crates.io is not published yet. Clone this repository and build from `rust/`:
128
+
129
+ ```bash
130
+ git clone https://github.com/Sqube-Groups/sqube-agent-control.git
131
+ cd sqube-agent-control/rust
132
+ cargo build
133
+ cargo test
134
+ ```
135
+
136
+ To depend on the crate from another Rust project before crates.io publish, use a path or git dependency in `Cargo.toml` (see [`rust/README.md`](rust/README.md)).
137
+
138
+ Packaging and releases for Python and Node.js are wired via GitHub Actions on version tags (`v*.*.*`). Configure repository secrets: `PYPI_API_TOKEN`, `NPM_TOKEN`.
139
+
140
+ ## Optional LLM probes
141
+
142
+ v0.1 guard decisions are **deterministic** — no LLM in the policy path. For manual experiments only (not CI, not `ExecutionGuard`), see [`examples/nvidia_kimi_vision_probe.py`](examples/nvidia_kimi_vision_probe.py) and [Optional LLM probes](https://sqube-groups.github.io/sqube-agent-control/docs/optional-llm-probes) on the docs site.
143
+
144
+ ```bash
145
+ pip install requests # or: pip install -e ".[probes]"
146
+ export NVIDIA_API_KEY="your-key"
147
+ python examples/nvidia_kimi_vision_probe.py
148
+ python examples/nvidia_kimi_vision_probe.py --no-stream
149
+ ```
150
+
151
+ ## Development
152
+
153
+ ```bash
154
+ # Python
155
+ pip install -e ".[dev]"
156
+ pytest
157
+
158
+ # Node
159
+ cd nodejs && npm ci && npm test
160
+
161
+ # Rust
162
+ cd rust && cargo test
163
+ ```
164
+
165
+ ## Documentation
166
+
167
+ **CI** runs on pull requests and pushes targeting `main`; **GitHub Pages** deploys only on pushes to `main`; **PyPI/npm releases** run only for `v*.*.*` tags whose commit is on `main`.
168
+
169
+ Published docs (Docusaurus) deploy to GitHub Pages on pushes to `main`:
170
+
171
+ **https://sqube-groups.github.io/sqube-agent-control/**
172
+
173
+ **Maintainers:** [Enable GitHub Pages (GitHub Actions source)](website/docs/deploy-pages.md), docs deploy behavior, and [release tag commands](website/docs/deploy-pages.md#release-tags-pypi--npm) — see [`website/docs/deploy-pages.md`](website/docs/deploy-pages.md).
174
+
175
+ Run locally:
176
+
177
+ ```bash
178
+ cd website && npm ci && npm start
179
+ ```
180
+
181
+ Keep private notes outside the repo under `docs_internal_never_commit/` (gitignored). Other common local-only folder names (`docs-never-commit/`, `.local-docs/`, `**/never-commit/`) are ignored as well.
182
+
183
+ ## Project structure
184
+
185
+ ```text
186
+ src/sqube_agent_guard/ # Python SDK
187
+ nodejs/ # TypeScript / npm SDK
188
+ rust/ # Rust crate
189
+ tests/ # Python tests
190
+ examples/ # Python examples
191
+ website/ # Docusaurus docs site (GitHub Pages)
192
+ ```
193
+
194
+ ## Contributing
195
+
196
+ Contributions and feedback are welcome. For larger changes, open an issue first.
197
+
198
+ ## License
199
+
200
+ Copyright © 2026 Sqube Groups — [Apache-2.0](LICENSE)
201
+
202
+ [Sqube](https://sqube.in)