Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,13 @@ PASS / REVIEW / FAIL
agent judgment
```

**Pre-release:** the package is currently `0.1.0.dev0` and is not yet published
to PyPI. Install it from a checkout for current use.

## Installation

[pipx](https://pipx.pypa.io/) keeps the command isolated from project
environments:

```bash
git clone https://github.com/stef-k/agent-code-guard.git
cd agent-code-guard
pipx install .
pipx install agent-code-guard
```

See the [usage guide](https://github.com/stef-k/agent-code-guard/blob/main/docs/usage.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/skill-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The `agent-code-guard` Python distribution is the single versioned release
unit. A pip, pipx, or uv tool installation receives the `code-guard` command,
its runtime, and an inert canonical Code Guard skill payload from the same
artifact version. Installation does not inspect or modify any agent directory
or configuration. The package is not yet published on PyPI, so validation and
development installations use local built artifacts or the repository.
or configuration. Installing `agent-code-guard` through pip, pipx, or uv
provides the command, runtime, and exact version-matched skill payload.

CLI-only use is fully supported. Install the Python distribution and run, for
example, `code-guard . --changed-only`. The bundled skill does not affect
Expand Down
26 changes: 15 additions & 11 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,35 @@
# Usage

## Current pre-release installation
## Installation

Agent Code Guard is currently `0.1.0.dev0` and is not published to PyPI. Install
the current pre-release from a checkout, preferably as an isolated CLI tool:
Install Agent Code Guard as an isolated CLI tool with pipx:

```bash
git clone https://github.com/stef-k/agent-code-guard.git
cd agent-code-guard
pipx install .
pipx install agent-code-guard
```

Inside an activated Python virtual environment, use:

```bash
python -m pip install .
python -m pip install agent-code-guard
```

An isolated uv tool installation is also available:

```bash
uv tool install agent-code-guard
```

For repository development, an editable install is available:
For source or repository development installs, run one of the following from a
checkout:

```bash
python -m pip install .
python -m pip install -e .
```

`uv tool install .` is also a supported local-tool alternative. The checkout
runner at `skills/code-guard/scripts/code_guard.py` exists for repository and
skill compatibility; it is not the primary installed command.
The checkout runner at `skills/code-guard/scripts/code_guard.py` exists for
repository and skill compatibility; it is not the primary installed command.

## Command and scope

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "agent-code-guard"
version = "0.1.0.dev0"
version = "0.1.0"
description = "Deterministic cross-language guardrails for agent-assisted development"
readme = "README.md"
requires-python = ">=3.10"
Expand Down
Loading