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.9.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.9-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oceansguard-0.1.9.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.9.tar.gz
Algorithm Hash digest
SHA256 296804d279bec8037afff468156a8acd90fc4a2a6d927bbd16c1ff1e17db3454
MD5 15748a7ac13047b4886f3083fc132355
BLAKE2b-256 64771bc485445f75c9a15b26df8e449b0b3d43f910de4f13991a7bd47ab8c4d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oceansguard-0.1.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 dea0c392b757797b0536719641326fbae39eba34d539fbdb60624449fe0edd84
MD5 82d72308d7cc76184a1dbc436e15c7f3
BLAKE2b-256 2ad19a495557e31273bd19115b0ec5c87a0e41c9bd2580783b4faee0272c24c6

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