argus-review-code 0.1.0__tar.gz

argus_review_code-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Nikita Filonov
+   Copyright 2026 sanghv (sang-hv)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

argus_review_code-0.1.0/NOTICE

@@ -0,0 +1,16 @@
+This project is a fork of "ArgusReview" (itself a fork/rebrand of the original
+"ai-review" project by Nikita Filonov), licensed under the Apache License,
+Version 2.0.
+
+Original work:
+  Copyright 2025 Nikita Filonov
+  https://github.com/Nikita-Filonov/ai-review
+
+Intermediate fork ("ArgusReview" / DEHA):
+  https://github.com/deha-project/argus-review
+
+Modifications and additions in this fork:
+  Copyright 2026 sanghv (sang-hv)
+  https://github.com/sang-hv/ai-code-review
+
+See the LICENSE file for the full Apache License, Version 2.0 text.

argus_review_code-0.1.0/PKG-INFO

@@ -0,0 +1,426 @@
+Metadata-Version: 2.4
+Name: argus-review-code
+Version: 0.1.0
+Summary: ArgusReview (sang-hv fork) is an AI-powered code review tool for GitHub, GitLab, Bitbucket Cloud, Bitbucket Server, Azure DevOps and Gitea
+Author-email: sanghv <supersentaj@gmail.com>
+Maintainer-email: sanghv <supersentaj@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Issues, https://github.com/sang-hv/ai-code-review/issues
+Project-URL: Homepage, https://github.com/sang-hv/ai-code-review
+Project-URL: Repository, https://github.com/sang-hv/ai-code-review
+Keywords: ai,code review,llm,openai,claude,gemini,ollama,bedrock,openrouter,ci/cd,gitlab,github,gitea,bitbucket,bitbucket cloud,bitbucket server,azure,azure devops,azure openai
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: typer
+Requires-Dist: httpx
+Requires-Dist: pyyaml
+Requires-Dist: loguru
+Requires-Dist: aiofiles
+Requires-Dist: pydantic
+Requires-Dist: pydantic-settings
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Dynamic: license-file
+
+# ArgusReview
+
+<p align="center">
+  <img src="./docs/assets/logo.png" alt="ArgusReview logo" width="220" />
+</p>
+
+AI-powered code review tool.
+
+> This is a personal fork ([sang-hv/ai-code-review](https://github.com/sang-hv/ai-code-review)) of ArgusReview
+> (originally [ai-review by Nikita Filonov](https://github.com/Nikita-Filonov/ai-review), rebranded by
+> [deha-project](https://github.com/deha-project/argus-review)). See [NOTICE](./NOTICE) for full attribution.
+
+[![CI](https://github.com/sang-hv/ai-code-review/actions/workflows/workflow-test.yml/badge.svg)](https://github.com/sang-hv/ai-code-review/actions/workflows/workflow-test.yml)
+[![PyPI version](https://img.shields.io/pypi/v/argus-review-code.svg)](https://pypi.org/project/argus-review-code/)
+[![License](https://img.shields.io/github/license/sang-hv/ai-code-review)](./LICENSE)
+
+---
+
+## 📑 Table of Contents
+
+- ✨ [About](#-about)
+- 🧪 [Live Preview](#-live-preview)
+- 🚀 [Quick Start](#-quick-start)
+- ⚙️ [️CI/CD Integration](#-cicd-integration)
+    - 🚀 [GitHub Actions](#-github-actions)
+    - 🚀 [GitLab CI/CD](#-gitlab-cicd)
+- 📘 [Documentation](#-documentation)
+- ⚠️ [Privacy & Responsibility Notice](#-privacy--responsibility-notice)
+
+---
+
+## ✨ About
+
+**ArgusReview** is a developer tool that brings **AI-powered code review** directly into your workflow. It helps teams
+improve code quality, enforce consistency, and speed up the review process.
+
+✨ Key features:
+
+- **Multiple LLM providers** — choose between **OpenAI**, **Claude**, **Gemini**, **Ollama**, **Bedrock**,
+  **OpenRouter**, or **Azure OpenAI** and switch anytime. Plus a generic **OpenAI-compatible** provider and a
+  **9Router** preset, so any OpenAI-style gateway (LMRouter, vLLM, LocalAI, LiteLLM, ...) works by just setting a base URL.
+- **Project coding conventions** — feed your team's standards (Markdown) into every review from a **local folder**, a
+  **raw URL**, or a **git repo** (public or private). The AI reviews against *your* rules, not just generic defaults.
+- **VCS integration** — works out of the box with **GitLab**, **GitHub**, **Bitbucket Cloud**, **Bitbucket Server**,
+  **Azure DevOps**, and **Gitea**.
+- **Customizable prompts** — adapt inline, context, and summary reviews to match your team's coding guidelines.
+- **Agent mode** — iterative ReAct-style loop where the model can **explore the repository** with shell commands
+  (`ls`, `cat`, `rg`, `git`) before producing a final review, giving it deeper context than a single-shot call.
+- **Reply modes** — AI can now **participate in existing review threads**, adding follow-up replies in both inline and
+  summary discussions.
+- **Flexible configuration** — supports `YAML`, `JSON`, and `ENV`, with seamless overrides in CI/CD pipelines.
+- **ArgusReview runs fully client-side** — it never proxies or inspects your requests.
+
+ArgusReview runs automatically in your CI/CD pipeline and posts both **inline comments**, **summary reviews**, and now
+**AI-generated replies** directly inside your merge requests. With **agent mode** enabled, the model can autonomously
+explore the codebase before reviewing, resulting in more accurate and context-aware feedback. This makes reviews faster,
+more conversational, and still fully under human control.
+
+---
+
+## 🧪 Live Preview
+
+Curious how **ArgusReview** works in practice? Here are real Pull Requests reviewed entirely by the tool — one per
+mode:
+
+| Mode             | Description                                                                                                                                  |
+|------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| 🧩 Inline        | Adds **line-by-line comments** directly in the diff. Focuses on specific code changes.                                                       |
+| 🧠 Context       | Performs a **broader analysis across multiple files**, detecting cross-file issues and inconsistencies.                                      |
+| 📄 Summary       | Posts a **concise high-level summary** with key highlights, strengths, and major issues.                                                     |
+| 💬 Inline Reply  | Generates a **context-aware reply** to an existing inline comment thread. Can clarify decisions, propose fixes, or provide code suggestions. |
+| 💬 Summary Reply | Continues the **summary-level review discussion**, responding to reviewer comments with clarifications, rationale, or actionable next steps. |
+
+👉 Each review was generated automatically via GitHub Actions using the corresponding mode:
+
+```bash
+argus-review run-inline
+argus-review run-summary
+argus-review run-context
+argus-review run-inline-reply
+argus-review run-summary-reply
+```
+
+---
+
+## 🚀 Quick Start
+
+Install via **pip**:
+
+```bash
+pip install argus-review-code
+```
+
+📦 Package name on PyPI: **`argus-review-code`** (the CLI command is still `argus-review`)
+
+Or install from source:
+
+```bash
+git clone https://github.com/sang-hv/ai-code-review.git
+cd ai-code-review
+pip install .
+```
+
+Or build the Docker image locally:
+
+```bash
+docker build -t ai-code-review:latest .
+docker run --rm -v $(pwd):/app ai-code-review:latest run-summary
+```
+
+👉 Before running, create a basic configuration file [.ai-review.yaml](./docs/configs/.ai-review.yaml) in the root of
+your project:
+
+```yaml
+llm:
+  provider: OPENAI
+
+  meta:
+    model: gpt-4o-mini
+    max_tokens: 1200
+    temperature: 0.3
+
+  http_client:
+    timeout: 120
+    api_url: https://api.openai.com/v1
+    api_token: ${OPENAI_API_KEY}
+
+vcs:
+  provider: GITLAB
+
+  pipeline:
+    project_id: "1"
+    merge_request_id: "100"
+
+  http_client:
+    timeout: 120
+    api_url: https://gitlab.com
+    api_token: ${GITLAB_API_TOKEN}
+```
+
+👉 This will:
+
+- Run ArgusReview against your codebase.
+- Generate inline and/or summary comments (depending on the selected mode).
+- Use your chosen LLM provider (OpenAI GPT-4o-mini in this example).
+
+> **Note:** Running `argus-review run` executes the full review (inline + summary).
+> To run only one mode, use the dedicated subcommands:
+> - argus-review run-inline
+> - argus-review run-context
+> - argus-review run-summary
+> - argus-review run-inline-reply
+> - argus-review run-summary-reply
+
+---
+
+ArgusReview can be configured via `.ai-review.yaml`, `.ai-review.json`, or `.env`. See [./docs/configs](./docs/configs)
+for complete, ready-to-use examples.
+
+Key things you can customize:
+
+- **LLM provider** — OpenAI, Gemini, Claude, Ollama, Bedrock, OpenRouter, Azure OpenAI, any **OpenAI-compatible**
+  endpoint, or **9Router**
+- **Model settings** — model name, temperature, max tokens
+- **VCS integration** — works out of the box with **GitLab**, **GitHub**, **Bitbucket Cloud**, **Bitbucket Server**,
+  **Azure DevOps**, and **Gitea**
+- **Agent mode** — enable iterative repository exploration before review
+- **Coding conventions** — load your team's `.md` standards from a local folder, a URL, or a git repo
+- **Review language** — have the AI write comments/summaries/replies in any language (English, Vietnamese, ...)
+- **Review policy** — which files to include/exclude, review modes
+- **Prompts** — inline/context/summary/agent prompt templates
+
+---
+
+### 🔌 OpenAI-compatible providers & 9Router
+
+Any gateway that speaks the OpenAI Chat Completions API works with the `OPENAI_COMPATIBLE` provider — you only set a
+base URL and a model:
+
+```yaml
+llm:
+  provider: OPENAI_COMPATIBLE
+  meta:
+    model: meta-llama/llama-3.1-70b-instruct
+  http_client:
+    api_url: https://my-router.example.com/v1
+    api_token: ${LLM_API_TOKEN}   # optional — omit for token-less local gateways
+```
+
+For the [9Router](https://9router.com) local proxy, use the `9ROUTER` preset. `api_url` defaults to
+`http://localhost:20128/v1`, so config stays minimal:
+
+```yaml
+llm:
+  provider: 9ROUTER
+  meta:
+    model: gpt-4o-mini
+```
+
+---
+
+### 📐 Project coding conventions
+
+Every team has its own standards. Point ArgusReview at your convention docs and they get injected into each review
+prompt automatically. Sources can be a local file/folder, a raw URL, or a git repo — private ones supported via token:
+
+```yaml
+conventions:
+  enabled: true
+  sources:
+    # Local file or folder of .md docs
+    - type: local
+      path: ./docs/conventions
+
+    # Raw Markdown from a URL (token optional, for private URLs)
+    - type: url
+      url: https://raw.githubusercontent.com/my-org/standards/main/PYTHON.md
+      token: ${CONVENTIONS_URL_TOKEN}
+
+    # .md docs pulled from a git repo (token optional, for private repos)
+    - type: git
+      repo: https://github.com/my-org/standards.git
+      ref: main
+      path: python
+      token: ${GIT_TOKEN}
+
+  # Optional: enable/disable per review mode (all on by default)
+  modes:
+    inline: true
+    context: true
+    summary: true
+    inline_reply: true
+    summary_reply: true
+```
+
+Convention loading is fail-soft: an unreachable source is logged and skipped, so a review is never blocked.
+
+---
+
+### 🌐 Review language
+
+Have the AI write its review (inline comments, summaries, and replies) in the language your team prefers. It's a
+single free-form field — use any language name the model understands. Code identifiers, file paths, and code snippets
+are always kept unchanged.
+
+```yaml
+review:
+  language: Vietnamese   # or English (default), Tiếng Việt, 日本語, Français, ...
+```
+
+👉 Minimal configuration is enough to get started. Use the full reference configs if you want fine-grained control (
+timeouts, artifacts, logging, etc.).
+
+---
+
+## ⚙️ CI/CD Integration
+
+ArgusReview works out-of-the-box with major CI providers.
+Use these snippets to run ArgusReview automatically on Pull/Merge Requests.  
+Each integration uses environment variables for LLM and VCS configuration.
+
+> For full configuration details (timeouts, artifacts, logging, prompt overrides), see [./docs/configs](./docs/configs).
+
+### 🚀 GitHub Actions
+
+Add a workflow like this (manual trigger from **Actions** tab):
+
+```yaml
+name: ArgusReview
+
+on:
+  workflow_dispatch:
+    inputs:
+      review-command:
+        type: choice
+        default: run
+        options:
+          - run
+          - run-inline
+          - run-context
+          - run-summary
+          - run-inline-reply
+          - run-summary-reply
+          - clear-inline
+          - clear-summary
+      pull-request-number:
+        type: string
+        required: true
+jobs:
+  argus-review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: sang-hv/ai-code-review@main
+        with:
+          review-command: ${{ inputs.review-command }}
+        env:
+          # --- LLM configuration ---
+          LLM__PROVIDER: "OPENAI"
+          LLM__META__MODEL: "gpt-4o-mini"
+          LLM__META__MAX_TOKENS: "15000"
+          LLM__META__TEMPERATURE: "0.3"
+          LLM__HTTP_CLIENT__API_URL: "https://api.openai.com/v1"
+          LLM__HTTP_CLIENT__API_TOKEN: ${{ secrets.OPENAI_API_KEY }}
+
+          # --- GitHub integration ---
+          VCS__PROVIDER: "GITHUB"
+          VCS__PIPELINE__OWNER: ${{ github.repository_owner }}
+          VCS__PIPELINE__REPO: ${{ github.event.repository.name }}
+          VCS__PIPELINE__PULL_NUMBER: ${{ inputs.pull-request-number }}
+          VCS__HTTP_CLIENT__API_URL: "https://api.github.com"
+          VCS__HTTP_CLIENT__API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+```
+
+🔗 Full example: [./docs/ci/github.yaml](./docs/ci/github.yaml)
+
+### 🚀 GitLab CI/CD
+
+For GitLab users:
+
+```yaml
+argus-review:
+  when: manual
+  stage: review
+  image: ai-code-review:latest   # build from this repo's Dockerfile and push to your own registry
+  rules:
+    - if: '$CI_MERGE_REQUEST_IID'
+  script:
+    - argus-review run
+  variables:
+    # --- LLM configuration ---
+    LLM__PROVIDER: "OPENAI"
+    LLM__META__MODEL: "gpt-4o-mini"
+    LLM__META__MAX_TOKENS: "15000"
+    LLM__META__TEMPERATURE: "0.3"
+    LLM__HTTP_CLIENT__API_URL: "https://api.openai.com/v1"
+    LLM__HTTP_CLIENT__API_TOKEN: "$OPENAI_API_KEY"
+
+    # --- GitLab integration ---
+    VCS__PROVIDER: "GITLAB"
+    VCS__PIPELINE__PROJECT_ID: "$CI_PROJECT_ID"
+    VCS__PIPELINE__MERGE_REQUEST_ID: "$CI_MERGE_REQUEST_IID"
+    VCS__HTTP_CLIENT__API_URL: "$CI_SERVER_URL"
+    VCS__HTTP_CLIENT__API_TOKEN: "$CI_JOB_TOKEN"
+  allow_failure: true  # Optional: don't block pipeline if ArgusReview fails
+
+```
+
+🔗 Full example: [./docs/ci/gitlab.yaml](./docs/ci/gitlab.yaml)
+
+---
+
+## 📘 Documentation
+
+See these folders for reference templates and full configuration options:
+
+- [./docs/ci](./docs/ci) — CI/CD integration templates (GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins)
+- [./docs/cli](./docs/cli) — CLI command reference and usage examples
+- [./docs/hooks](./docs/hooks) — hook reference and lifecycle events
+- [./docs/configs](./docs/configs) — full configuration examples (`.yaml`, `.json`, `.env`)
+- [./docs/prompts](./docs/prompts) — prompt templates for Python/Go (light & strict modes)
+- [./docs/troubleshooting.md](./docs/troubleshooting) — common environment and Git-related issues
+
+---
+
+## ⚠️ Privacy & Responsibility Notice
+
+ArgusReview does **not store**, **log**, or **transmit** your source code to any external service other than the **LLM
+provider** explicitly configured in your `.ai-review.yaml`.
+
+All data is sent **directly** from your CI/CD environment to the selected LLM API endpoint (e.g. OpenAI, Gemini,
+Claude, OpenRouter). No intermediary servers or storage layers are involved.
+
+If you use **Ollama**, requests are sent to your **local or self-hosted Ollama runtime**  
+(by default `http://localhost:11434`). This allows you to run reviews completely **offline**, keeping all data strictly
+inside your infrastructure.
+
+> ⚠️ Please ensure you use proper API tokens and avoid exposing corporate or personal secrets.
+> If you accidentally leak private code or credentials due to incorrect configuration (e.g., using a personal key
+> instead of an enterprise one), it is **your responsibility** — the tool does not retain or share any data by itself.
+
+---
+
+🧠 **ArgusReview** — open-source AI-powered code reviewer
+
+- 📂 [Source (this fork)](https://github.com/sang-hv/ai-code-review)
+- 📦 [PyPI](https://pypi.org/project/argus-review-code/)
+- 📜 [NOTICE — attribution & fork history](./NOTICE)