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.1.tar.gz (12.1 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.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oceansguard-0.1.1.tar.gz
  • Upload date:
  • Size: 12.1 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.1.tar.gz
Algorithm Hash digest
SHA256 332feac1563c784cce4e37495dfad1d53e768d459c024bacf83b2ca6b85e25a2
MD5 91b29c2ba7fdda9d16ecd71cd34512ef
BLAKE2b-256 4e745207d5ffd648588c6ffca0dc4e6706777b75e4332301668fe368fff117ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oceansguard-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 92ea7e0141f8374fa0fccd67f5f73662d6fee9f671048ef5ae3e82d8f8d4841a
MD5 8b2c4ce534a9ed21779c1dfa00bda93f
BLAKE2b-256 8319dbe62e926af7e371d6da32d7fa9a01dd9ddbfe703a5e9ee12ad39ccfc465

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