Skip to main content

Guardrails tool for AI-assisted code changes (pack / check / run)

Project description

README.md

OceansGuard

AI-assisted development guardrails for any repository.

What it solves

  • AI-generated changes that accidentally drop existing code
  • Lack of global context (only partial files shown)
  • Forgetfulness / inconsistent constraints across sessions
  • No test / lint guarantees
  • Secret leakage (keys/tokens) into commits
  • Risky full-rewrite changes

Core commands

init

Create minimal guard files in target repo (idempotent; no overwrite).

python core/aiguard.py init --repo .

pack

Generate AI context pack (diff-first).

python core/aiguard.py pack --repo .

check

Run guard checks + configured project checks and write reports.

python core/aiguard.py check --repo .

run

Shortcut = pack + check.

python core/aiguard.py run --repo . --task "your task"

Strict mode

--strict makes guardrails non-negotiable:

  • requires PyYAML
  • fails if checks.commands is empty
  • fails if contracts/openapi.json is missing/empty
python core/aiguard.py run --repo . --task "CI guard" --strict

Submodule usage (recommended)

In your target repository:

git submodule add https://github.com/OceansCreative/OceansGuard.git tools/OceansGuard
python tools/OceansGuard/core/aiguard.py init --repo .
python tools/OceansGuard/core/aiguard.py run --repo . --task "初回ガード適用"

Outputs

  • ai_context_pack.md: single file to paste into AI chat
  • ai_test_last.log: raw execution logs
  • ai_check_report.json: structured result for CI/PR gating

Git hooks (prevent committing to main)

Install with:

python core/install_hooks.py --repo .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oceansguard-0.1.6.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oceansguard-0.1.6-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file oceansguard-0.1.6.tar.gz.

File metadata

  • Download URL: oceansguard-0.1.6.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for oceansguard-0.1.6.tar.gz
Algorithm Hash digest
SHA256 124377c893e84407d0e19f2820b29be395711c1118347ee7282bd351b7a6ace5
MD5 4312a7283c3201701951975152a956ca
BLAKE2b-256 b5df79ac33534ed768c74d6c289320d2a5ac62137b7551f8461da5c14b0006be

See more details on using hashes here.

File details

Details for the file oceansguard-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: oceansguard-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for oceansguard-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d3306198c43249cf6823a7f5a1a8f028c3b970dff04067c18af8c582cf7cb73a
MD5 47bb341dde7ce1424b9f8fa21c2b933c
BLAKE2b-256 7de5f6ad9cad570a3a2bcf5176c7185ea2f64eb8dc84852440e30af486345a8c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page