gfreview 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Martin C. Richards
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# Git Forge Review
+
+CLI for managing code reviews on git forges
+
+## Installation
+
+### Quick Install (curl | bash)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/martinffx/gfreview/main/install.sh | bash
+```
+
+#### Options
+
+```bash
+# Install to custom location (default: /usr/local/bin)
+curl -fsSL https://raw.githubusercontent.com/martinffx/gfreview/main/install.sh | BIN_DIR=~/.local/bin bash
+
+# Install specific version
+curl -fsSL https://raw.githubusercontent.com/martinffx/gfreview/main/install.sh | VERSION=v0.1.0 bash
+```
+
+### npm
+
+```bash
+npm install -g gfreview
+```
+
+### From Source
+
+```bash
+bun install
+bun run build
+```
+
+## Configuration
+
+Environment variables:
+
+- `GFREVIEW_TOKEN` — Required (GitHub PAT or GitLab token)
+- `GFREVIEW_URL` — Default: https://github.com or https://gitlab.com
+- `GFREVIEW_FORGE` — gitlab or github (auto-detected)
+- `GFREVIEW_PROJECT` — Optional: owner/repo or group/project
+
+Or use a config file at `$XDG_CONFIG_HOME/gfreview/config.toml`:
+
+```toml
+forge = "github"
+url = "https://github.com"
+project = "owner/repo"
+```
+
+## Usage
+
+### PR Management
+
+```
+gfreview list                              # List open PRs
+gfreview view <id>                         # Show PR details
+gfreview create --title <title> --source-branch <branch> --target-branch <branch>
+gfreview approve <id>
+gfreview merge <id>
+```
+
+### Review Workflow
+
+```
+gfreview review start <id>                                       # Open session, cache SHAs
+gfreview review comment <id> --file <path> --line <n> --body <text>
+gfreview review submit <id> [--body <text>]
+gfreview review status <id>
+gfreview review discard <id>
+```
+
+### Comments
+
+```
+gfreview diff <id>
+gfreview comments <id>
+gfreview resolve <id> --discussion-id <id>
+gfreview note <id> --body <text>
+```
+
+### Shared Flags
+
+- --forge gitlab|github — Override detected forge
+- --project <path> — Override project
+- --json — JSON output
+- --body - | @<path> — Read body from stdin or file
+
+## Diff Format
+
+gfreview diff outputs an LLM-optimized format with line numbers that map directly to --line arguments.
+
+## Agent Workflow
+
+gfreview diff <id> # Read annotated diff
+gfreview review start <id> # Open session, cache SHAs
+gfreview review comment ... # Stage comments
+gfreview review submit <id> # Submit (or warn if stale)
+gfreview comments <id> # Verify
+
+## Development
+
+- bun test — Run tests
+- bun run types — Type check
+- bun run lint — Lint
+- bun run format:check — Check formatting
+- bun run build — Compile to binary
+
+## Architecture
+
+- v0.1: GitHub support
+- v0.2: GitLab support (architecture in place)
+
+The CLI uses a forge-agnostic interface — GitLab and GitHub clients implement the same API.