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.12.tar.gz (23.5 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.12-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oceansguard-0.1.12.tar.gz
  • Upload date:
  • Size: 23.5 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.12.tar.gz
Algorithm Hash digest
SHA256 2cfee3b60410b4af2be5f660c590e1f673932fdd28f0601346133566fcc00345
MD5 1893cf420bbf38d7a5881dd7400ec0b2
BLAKE2b-256 a7e1f0753a362fdd4d66b03fff22e77149d01c1e82a12c07ee3de8df34ea691f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oceansguard-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 21.3 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 53f09497696df507b4cf209ef94490629c8eb62ef5ce8beafe8688735af34b8c
MD5 573bb6c46a6c87ea662ed95474c0a4bc
BLAKE2b-256 83fef72452e26a3cc9a0684c5b63424567b069837b6b53f80f5bec037a7fdc4a

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