### Setup Git-LRC Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use 'lrc setup' for a guided onboarding process, including initial authentication and configuration. This command helps in setting up the tool for the first time. ```bash lrc setup ``` -------------------------------- ### Setup Git-LRC Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Run this command to initiate the setup process for Git-LRC, which includes API key configuration. ```bash git lrc setup ``` -------------------------------- ### Start LiveReview API Server Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Command to start the LiveReview API server, which is a prerequisite for the LRC tool. ```bash ./livereview api ``` -------------------------------- ### Example TOML Configuration Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Example content for the `~/.lrc.toml` configuration file. This file stores your API key and endpoint. ```toml # Your LiveReview API key api_key = "lr_example_token" # Your LiveReview API endpoint (base URL, without /api suffix) # The CLI automatically appends /api/v1/diff-review api_url = "https://manual-talent.apps.hexmos.com" ``` -------------------------------- ### SetupListConnectors Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Inspects the minimum AI readiness during setup and re-authentication preflight by listing existing connector inventory for the current organization. ```APIDOC ## SetupListConnectors ### Description Inspects the minimum AI readiness during setup and re-authentication preflight by listing existing connector inventory for the current organization. ### Method api ### Purpose Inspect minimum AI readiness during setup and re-auth preflight ``` -------------------------------- ### Build and Install git-lrc Locally Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Build the project locally and install the git-lrc hooks. Ensure you are using the Go version declared in go.mod. ```bash make build-local && lrc hooks install ``` -------------------------------- ### Install Git-LRC on Linux/macOS Source: https://github.com/hexmostech/git-lrc/blob/main/docs/releases/_template.md Use this command to perform a new installation of Git-LRC on Linux or macOS systems. ```bash # Linux/macOS curl -L https://hexmos.com/ipm-install | bash && ipm i HexmosTech/git-lrc ``` -------------------------------- ### Setup API Key and Endpoint in Config File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Configure your API key and endpoint by creating a `~/.lrc.toml` file. This allows you to run `lrc` without specifying these details each time. Ensure the config file is protected with `chmod 600`. ```bash cat > ~/.lrc.toml << EOF # Your LiveReview API key api_key = "lr_example_token" # Your LiveReview API endpoint api_url = "https://manual-talent.apps.hexmos.com" EOF # Protect your config file chmod 600 ~/.lrc.toml # Now you can run lrc without specifying the key or URL lrc ``` -------------------------------- ### Install Git-LRC on Windows Source: https://github.com/hexmostech/git-lrc/blob/main/docs/releases/_template.md Use this command to perform a new installation of Git-LRC on Windows systems using PowerShell. ```powershell # Windows iwr https://hexmos.com/ipm-install-ps | iex; ipm i HexmosTech/git-lrc ``` -------------------------------- ### Install Git Hooks Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Install pre-commit hooks to automatically trigger code reviews before each commit. This ensures code quality is checked continuously. ```bash lrc hooks install ``` -------------------------------- ### Install Git-LRC via GitHub Codespaces Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Install Git-LRC directly within GitHub Codespaces using this command. ```bash curl -fsSL https://git.new/lrc-install | bash ``` -------------------------------- ### Live UI Development Loop Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Start the live development loop for the UI. This allows editing files under internal/staticserve/static/ and refreshing the browser without rebuilding the binary. ```bash make dev-ui ``` -------------------------------- ### Install Global Claude Hook Source: https://github.com/hexmostech/git-lrc/blob/main/hooks/claude/SKILL.md Installs the global Claude Git hook. This manages integration files in ~/.lrc/claude/hooks/ and ~/.claude/settings.json. ```bash lrc hooks install --surface claude ``` -------------------------------- ### Install git-lrc on Linux/macOS Source: https://github.com/hexmostech/git-lrc/blob/main/docs/releases/v0.4.8.md Installs git-lrc using curl and the ipm package manager for Linux and macOS systems. ```bash curl -L https://hexmos.com/ipm-install | bash && ipm i HexmosTech/git-lrc ``` -------------------------------- ### Install Internal Git-LRC via Shell Source: https://github.com/hexmostech/git-lrc/blob/main/docs/internal_install.md Use this command to install the internal release of Git-LRC on Linux or macOS systems. It downloads and executes the installation script. ```shell curl -fsSL https://hexmos.com/lrc-install.sh | LRC_RELEASE_CHANNEL=internal bash ``` -------------------------------- ### Install Internal Git-LRC via PowerShell Source: https://github.com/hexmostech/git-lrc/blob/main/docs/internal_install.md Use this command to install the internal release of Git-LRC on Windows systems. It sets the release channel environment variable and then executes the installation script. ```powershell $env:LRC_RELEASE_CHANNEL="internal" iwr -useb https://hexmos.com/lrc-install.ps1 | iex ``` -------------------------------- ### Pretty Output Example Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Displays the default human-readable output format for LiveReview results. This format includes a summary, file-specific comments, and severity levels. ```text ================================================================================ LIVEREVIEW RESULTS ================================================================================ Summary: The code looks good overall. Minor suggestions below. 2 file(s) with comments: -------------------------------------------------------------------------------- FILE: src/main.go -------------------------------------------------------------------------------- [WARNING] Line 42 (best-practices) Consider using context.WithTimeout instead of time.Sleep [INFO] Line 89 (style) Variable name could be more descriptive ================================================================================ Review complete: 2 total comment(s) ================================================================================ ``` -------------------------------- ### Check git-lrc Version and Hooks Status Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Verify the installed git-lrc version and check the status of the installed hooks. ```bash lrc version lrc hooks status ``` -------------------------------- ### SetupEnsureCloudUser Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Ensures that a cloud user record exists during the setup process. This API handles authenticated identity payloads. ```APIDOC ## SetupEnsureCloudUser ### Description Ensures that a cloud user record exists during the setup process. This API handles authenticated identity payloads. ### Method api ### Purpose Ensure cloud user record exists during setup ``` -------------------------------- ### JSON Output Example Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Machine-readable JSON output format for automation purposes, detailing review status and file-specific comments. ```json { "status": "completed", "summary": "The code looks good overall. Minor suggestions below.", "files": [ { "file_path": "src/main.go", "hunks": [...], "comments": [ { "line": 42, "content": "Consider using context.WithTimeout instead of time.Sleep", "severity": "warning", "category": "best-practices" } ] } ] } ``` -------------------------------- ### Run Default Review Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Executing 'lrc' or 'lrc review' without arguments runs a code review with sensible default settings. This is the quickest way to start a review. ```bash lrc lrc review ``` -------------------------------- ### Basic lrc Usage Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Submit staged changes for review using your API key. This is the simplest way to start a code review. ```bash lrc --api-key YOUR_API_KEY ``` -------------------------------- ### Verify Git-LRC Version Source: https://github.com/hexmostech/git-lrc/blob/main/docs/releases/_template.md Check the currently installed version of Git-LRC using this command. ```bash lrc --version ``` -------------------------------- ### ReviewForwardJSONWithBearer Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Forwards authenticated JSON requests across setup flows using a bearer token and organization context. ```APIDOC ## ReviewForwardJSONWithBearer ### Description Forwards authenticated JSON requests across setup flows using a bearer token and organization context. ### Method api ### Purpose Forward authenticated JSON requests across setup flows ``` -------------------------------- ### SetupRefreshTokens Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Refreshes authentication session tokens during setup and re-authentication flows. It handles refresh token requests and returned token sets. ```APIDOC ## SetupRefreshTokens ### Description Refreshes authentication session tokens during setup and re-authentication flows. It handles refresh token requests and returned token sets. ### Method api ### Purpose Refresh auth session tokens during setup and re-auth flows ``` -------------------------------- ### Run Plain Commit Hook Proof Script Source: https://github.com/hexmostech/git-lrc/blob/main/scripts/plain-commit-hook-proof/README.md Execute the main driver script for the plain commit hook proof. This script orchestrates the creation of a temporary workspace, setup of Git hooks, and execution of commit tests. ```bash python3 scripts/plain-commit-hook-proof/driver.py ``` -------------------------------- ### Start Review with git-lrc via WebStorm Terminal Source: https://github.com/hexmostech/git-lrc/wiki/JetBrains-WebStorm-IDE Initiate a git-lrc review for staged changes directly from WebStorm's terminal. Optional flags like --skip or --vouch can be used. ```bash lrc review --staged ``` -------------------------------- ### Update Git-LRC Source: https://github.com/hexmostech/git-lrc/blob/main/docs/releases/_template.md Run this command to update your existing Git-LRC installation to the latest version. ```bash lrc self-update ``` -------------------------------- ### Uninstall Git Hooks Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Remove previously installed pre-commit hooks. Use this if you no longer want automatic code reviews. ```bash lrc hooks uninstall ``` -------------------------------- ### Complete Workflow with All Output Options Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Execute a full review process including saving the bundle, JSON, text, and HTML outputs, and enabling verbose mode. Inspect the generated files using appropriate tools like `jq` for JSON and text editors for comments. ```bash # Run review with all inspection/output options lrc \ --save-bundle bundle.txt \ --save-json review.json \ --save-text review.txt \ --save-html review.html \ --verbose # Review the bundle that was sent cat bundle.txt # Check the raw JSON response jq . review.json # Navigate through comments in text file # Search for ">>>COMMENT<<<" to jump between comments vim review.txt # Open HTML review in browser (best for visual inspection) xdg-open review.html ``` -------------------------------- ### SetupCreateAPIKey Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Creates a connector or review API key. This operation handles the API key label and returns the plaintext API key. ```APIDOC ## SetupCreateAPIKey ### Description Creates a connector or review API key. This operation handles the API key label and returns the plaintext API key. ### Method api ### Purpose Create connector/review API key ``` -------------------------------- ### Provide API Key via Config File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Recommended method for providing the API key using a configuration file located at ~/.lrc.toml. ```bash echo 'api_key = "your-key"' > ~/.lrc.toml ``` -------------------------------- ### Display Git-LRC Help Source: https://github.com/hexmostech/git-lrc/blob/main/docs/releases/_template.md Access the help documentation for Git-LRC to see available commands and options. ```bash lrc --help ``` -------------------------------- ### SetupCreateConnector Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Persists connector configuration via the LiveReview API. This operation handles the connector configuration payload. ```APIDOC ## SetupCreateConnector ### Description Persists connector configuration via the LiveReview API. This operation handles the connector configuration payload. ### Method api ### Purpose Persist connector configuration via LiveReview API ``` -------------------------------- ### Build lrc Directly with Go Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Build the lrc binary directly using the Go toolchain. Specify the output file name. ```bash go build -o lrc . ``` -------------------------------- ### Configure lrc with TOML File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Set up your LiveReview API key and API URL in a TOML configuration file. This provides a persistent configuration. ```bash cp cmd/lrc/.lrc.toml.sample ~/.lrc.toml vim ~/.lrc.toml chmod 600 ~/.lrc.toml ``` -------------------------------- ### Run lrc with Config File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Execute the lrc CLI after setting up the configuration file. No flags are needed if all required parameters are in the config. ```bash lrc ``` -------------------------------- ### Inspect Bundle Before Sending Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Save the bundle to a file for inspection before submitting it to the LiveReview API. Use `less` to review the contents of the saved bundle file. ```bash # Save the bundle for inspection before submitting lrc --save-bundle bundle.txt # Review the bundle file to see what will be sent less bundle.txt ``` -------------------------------- ### Provide API Key via Command-Line Flag Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Method for providing the API key directly on the command line using the --api-key flag. ```bash lrc --api-key your-key ``` -------------------------------- ### Build lrc Locally Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Build the lrc binary for local use. This is a common first step for development or testing. ```bash make build-local ``` -------------------------------- ### Vouch for Code Review Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use this command to indicate that you take responsibility for the code after review iterations or personal inspection, skipping further AI review. ```bash git lrc review --vouch ``` -------------------------------- ### Commit Changes via WebStorm Terminal Source: https://github.com/hexmostech/git-lrc/wiki/JetBrains-WebStorm-IDE Execute this command in WebStorm's terminal to commit staged changes with a message. git-lrc will automatically start the review process. ```bash git commit -m "commit message" ``` -------------------------------- ### Run Main Confidence Lanes Tests Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Execute different sets of tests based on the area of change. Use the cheapest lane that proves the behavior. ```bash make test-go ``` ```bash make test-simulator ``` ```bash make test-hooks-worktree ``` ```bash make test-hooks-claude ``` ```bash make test-js ``` ```bash make testall ``` -------------------------------- ### Review Changes from File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Submit changes from a local diff file for review. This allows you to review pre-generated diffs. ```bash lrc --api-key YOUR_API_KEY --diff-source file --diff-file my-changes.diff ``` -------------------------------- ### Verify Status Document References Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Run this command to ensure that line references in status documents accurately reflect the code. ```bash make check-status-doc ``` -------------------------------- ### Vouch for a Commit Source: https://github.com/hexmostech/git-lrc/blob/main/README.md The '--vouch' flag allows you to skip the AI review and take personal responsibility for the commit. Use this when you are confident in the changes. ```bash lrc review --vouch ``` -------------------------------- ### Launch Git-LRC UI Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use this command to launch the Git-LRC user interface for managing AI connectors and settings. ```bash lrc ui ``` -------------------------------- ### Run Fake Review Mode for End-to-End Testing Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Perform end-to-end testing without making real AI calls by using a fake review mode. Adjust the wait time as needed. ```bash make build-local-test WAIT=30s make run-fake-review ``` -------------------------------- ### Show Version Information Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use 'lrc version' to display the current version of the git-lrc tool. This is helpful for troubleshooting and compatibility checks. ```bash lrc version ``` -------------------------------- ### Manual Review Before Commit Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Manually trigger an AI review before committing. Options include a standard review, vouching for the code, or skipping the review entirely. ```bash git add . git lrc review # run AI review first # or: git lrc review --vouch # vouch personally, skip AI # or: git lrc review --skip # skip review entirely git commit -m "add payment validation" ``` -------------------------------- ### Provide API Key via Environment Variable Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Alternative method for providing the API key by setting the LRC_API_KEY environment variable. ```bash export LRC_API_KEY="your-key" ``` -------------------------------- ### SetupValidateConnectorKey Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Validates an AI connector key before it is persisted. This API handles the provider key and validation request body. ```APIDOC ## SetupValidateConnectorKey ### Description Validates an AI connector key before it is persisted. This API handles the provider key and validation request body. ### Method api ### Purpose Validate AI connector key before persistence ``` -------------------------------- ### Verify API Key via Environment Variable Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Check the value of the LRC_API_KEY environment variable to confirm it is set correctly. ```bash echo $LRC_API_KEY ``` -------------------------------- ### Review Working Tree Changes Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Submit changes directly from your working tree for review. This includes uncommitted and unstaged modifications. ```bash lrc --api-key YOUR_API_KEY --diff-source working ``` -------------------------------- ### JSON Output for Scripting Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Obtain review results in JSON format for use in scripts or automated workflows. Redirect the output to a file using `> review-results.json`. ```bash lrc --api-key YOUR_API_KEY --output json > review-results.json ``` -------------------------------- ### Review a Specific Prior Commit Source: https://github.com/hexmostech/git-lrc/blob/main/hooks/claude/SKILL.md Initiates a review for a specific prior commit, identified by its hash or reference like HEAD. ```bash lrc review --commit HEAD ``` -------------------------------- ### Review Unstaged (Working Directory) Changes Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Review changes that are present in your working directory but not yet staged. Use the `--diff-source working` flag to specify this mode. ```bash # Review working directory changes (unstaged) lrc --api-key YOUR_API_KEY --diff-source working ``` -------------------------------- ### Skip Review and Write Attestation Source: https://github.com/hexmostech/git-lrc/blob/main/hooks/claude/SKILL.md Skips the AI review process for staged changes and allows the user to write an attestation instead. Use this when explicitly asked to bypass review. ```bash lrc review --staged --skip ``` -------------------------------- ### Enable Git-LRC Hooks for a Repo Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Re-enable Git-LRC hooks for the current repository to resume AI reviews on commits. ```bash git lrc hooks enable ``` -------------------------------- ### Simulator HTTP Endpoints Source: https://github.com/hexmostech/git-lrc/blob/main/internal/simulator/README.md The simulator exposes several HTTP endpoints to mimic actions within the system for testing purposes. ```APIDOC ## POST /commit ### Description Initiates a commit action within the simulator. ### Method POST ### Endpoint /commit ### Request Body - **message** (string) - Optional - The commit message. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the commit action. ### Request Example { "message": "Initial commit" } ### Response Example { "status": "committed" } ``` ```APIDOC ## POST /commit-push ### Description Initiates a commit and push action within the simulator. ### Method POST ### Endpoint /commit-push ### Request Body - **message** (string) - Optional - The commit message. ### Response #### Success Response (200) - **status** (string) - Indicates the success of the commit-push action. ### Request Example { "message": "Commit and push changes" } ### Response Example { "status": "committed and pushed" } ``` ```APIDOC ## POST /skip ### Description Initiates a skip action within the simulator. ### Method POST ### Endpoint /skip ### Response #### Success Response (200) - **status** (string) - Indicates the success of the skip action. ### Response Example { "status": "skipped" } ``` ```APIDOC ## POST /vouch ### Description Initiates a vouch action within the simulator. ### Method POST ### Endpoint /vouch ### Response #### Success Response (200) - **status** (string) - Indicates the success of the vouch action. ### Response Example { "status": "vouched" } ``` ```APIDOC ## POST /abort ### Description Initiates an abort action within the simulator. ### Method POST ### Endpoint /abort ### Response #### Success Response (200) - **status** (string) - Indicates the success of the abort action. ### Response Example { "status": "aborted" } ``` -------------------------------- ### Search Review Comments in Text File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Demonstrates how to search for comments within the text file generated by --save-text using grep. ```bash grep ">>>COMMENT<<<".review.txt ``` -------------------------------- ### Review a Saved Diff File Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Review changes from a diff file that has been previously generated. Use `--diff-source file` and specify the diff file path with `--diff-file`. ```bash git diff main..feature-branch > changes.diff lrc --api-key YOUR_API_KEY --diff-source file --diff-file changes.diff ``` -------------------------------- ### Manually Vouch for Changes Source: https://github.com/hexmostech/git-lrc/blob/main/hooks/claude/SKILL.md Manually approves changes without an AI review. Use this when the user explicitly wants to vouch for the code. ```bash lrc review --staged --vouch ``` -------------------------------- ### Toggle All File Expansion Source: https://github.com/hexmostech/git-lrc/blob/main/internal/staticserve/static/lrc-review-972182303.html Toggles the expansion state of all files and updates the button text accordingly. Manages a global 'allExpanded' state to track the current view. ```javascript let allExpanded = false; function toggleAll() { const files = document.querySelectorAll('.file'); const button = document.querySelector('.expand-all'); if (allExpanded) { files.forEach(f => { f.classList.remove('expanded'); f.classList.add('collapsed'); }); button.textContent = 'Expand All Files'; allExpanded = false; } else { files.forEach(f => { f.classList.remove('collapsed'); f.classList.add('expanded'); }); button.textContent = 'Collapse All Files'; allExpanded = true; } } ``` -------------------------------- ### Review Staged Changes Source: https://github.com/hexmostech/git-lrc/blob/main/hooks/claude/SKILL.md Initiates an AI review for staged changes in the current repository. This command will block until a browser-based decision is made. ```bash lrc review --staged --blocking-review ``` -------------------------------- ### Review Specific Commits Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use the 'review' command with the --commit flag to specify which commit or range of commits to review. This is useful for inspecting historical changes. ```bash git lrc review --commit HEAD # review the last commit git lrc review --commit HEAD~3..HEAD # review a range ``` -------------------------------- ### Review Staged Changes Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Review all staged changes in your Git repository. Ensure changes are staged using `git add .` before running the `lrc` command with your API key. ```bash # Review all staged changes git add . lrc --api-key YOUR_API_KEY ``` -------------------------------- ### Basic CSS Reset and Variables Source: https://github.com/hexmostech/git-lrc/blob/main/internal/staticserve/static/lrc-review-972182303.html Applies a basic CSS reset for margin, padding, and box-sizing, and defines CSS variables for consistent spacing throughout the document. ```css * { margin: 0; padding: 0; box-sizing: border-box; } :root { --space-xs: 6px; --space-sm: 10px; --space-md: 16px; --space-lg: 24px; --space-xl: 32px; } ``` -------------------------------- ### Run Specific Package Tests Source: https://github.com/hexmostech/git-lrc/blob/main/CONTRIBUTING.md Execute tests for a specific package within the project. This is a focused approach to validation. ```bash make test-pkg PKG=./path/to/package ``` -------------------------------- ### SelfUpdateDownloadBinaryTo Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Downloads the release binary to a target path. This operation handles binary stream bytes for the executable update artifact. ```APIDOC ## SelfUpdateDownloadBinaryTo ### Description Downloads the release binary to a target path. This operation handles binary stream bytes for the executable update artifact. ### Method api ### Purpose Download release binary to target path ``` -------------------------------- ### Save Review Results to Files Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Save review results in JSON, formatted text, or HTML formats. Use `grep` or editor search to find comments in the text file. Open the HTML file in a browser for visual inspection. ```bash # Save both JSON and formatted text output lrc --save-json review.json --save-text review.txt # Save HTML output for viewing in browser lrc --save-html review.html # Save all formats lrc --save-json review.json --save-text review.txt --save-html review.html # Search for comments in the text file grep -n ">>>COMMENT<<<" review.txt # Or use your editor's search function to jump between comments vim review.txt # then search for: />>>COMMENT<<< # Open HTML review in browser xdg-open review.html # Linux open review.html # macOS start review.html # Windows ``` -------------------------------- ### Save Review Text for Analysis Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Use the --save-text option to generate a searchable text file containing review comments and markers. ```bash lrc --save-text review.txt ``` -------------------------------- ### Stage Changes via WebStorm Terminal Source: https://github.com/hexmostech/git-lrc/wiki/JetBrains-WebStorm-IDE Use this command in WebStorm's built-in terminal to stage all current changes before committing. ```bash git add . ``` -------------------------------- ### SelfUpdateFetchReleaseManifest Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Retrieves the release details for the current target platform, including platform-specific release manifest data. ```APIDOC ## SelfUpdateFetchReleaseManifest ### Description Retrieves the release details for the current target platform, including platform-specific release manifest data. ### Method api ### Purpose Retrieve release details for current target platform ``` -------------------------------- ### Automatic Review on Commit Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Stage your changes and commit. Git-LRC will automatically launch an AI review before the commit is finalized. ```bash git add . git commit -m "add payment validation" # review launches automatically before the commit goes through ``` -------------------------------- ### Review a Range of Commits Source: https://github.com/hexmostech/git-lrc/blob/main/README.md To review multiple commits, specify a range using '--commit HEAD~3..HEAD'. This command is useful for analyzing a sequence of changes. ```bash lrc review --commit HEAD~3..HEAD ``` -------------------------------- ### Save API Bundle for Inspection Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Use the --save-bundle option to inspect the exact payload transmitted to the API, including diff content and encoded data. ```bash lrc --save-bundle bundle.txt --verbose ``` -------------------------------- ### Container Styling Source: https://github.com/hexmostech/git-lrc/blob/main/internal/staticserve/static/lrc-review-972182303.html Sets a maximum width for the content container and centers it on the page. It uses flexbox for vertical layout and defines gaps between elements. ```css .container { max-width: 1400px; margin: 0 auto; width: 100%; padding: 0 var(--space-xl); display: flex; flex-direction: column; gap: var(--space-lg); } ``` -------------------------------- ### Review Git Range Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Submit changes within a specified Git range for review. This is useful for reviewing specific commits or branches. ```bash lrc --api-key YOUR_API_KEY --diff-source range --range HEAD~1..HEAD ``` -------------------------------- ### SelfUpdateFetchManifest Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Retrieves the global update manifest, including update manifest metadata and checksum references. ```APIDOC ## SelfUpdateFetchManifest ### Description Retrieves the global update manifest, including update manifest metadata and checksum references. ### Method api ### Purpose Retrieve global update manifest ``` -------------------------------- ### ReviewProxyRequest Source: https://github.com/hexmostech/git-lrc/blob/main/network/network_status.md Proxies generic forwarded payloads with API key authentication to a configured endpoint. This is used for events or webhook-style calls. ```APIDOC ## ReviewProxyRequest ### Description Proxies generic forwarded payloads with API key authentication to a configured endpoint. This is used for events or webhook-style calls. ### Method api ### Purpose Proxy events/webhook-style calls to configured endpoint ``` -------------------------------- ### Verbose Mode for Debugging Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Enable verbose output for debugging purposes. This flag provides more detailed information about the review process. ```bash lrc --api-key YOUR_API_KEY --verbose ``` -------------------------------- ### Header Styling Source: https://github.com/hexmostech/git-lrc/blob/main/internal/staticserve/static/lrc-review-972182303.html Styles the main header section with padding, a semi-transparent dark background, and a bottom border. It includes a shadow effect, border-radius, and backdrop filter for a frosted glass appearance. ```css .header { padding: var(--space-md) var(--space-lg); background: rgba(15,23,42,0.9); border-bottom: 1px solid rgba(255,255,255,0.08); border-radius: 18px; margin-bottom: var(--space-lg); box-shadow: 0 10px 30px rgba(0,0,0,0.4); backdrop-filter: blur(6px); } ``` -------------------------------- ### Body Styling and Background Source: https://github.com/hexmostech/git-lrc/blob/main/internal/staticserve/static/lrc-review-972182303.html Styles the body with a specific font, size, color, and a radial gradient background. It also sets up flex display for layout and defines overall padding and overflow behavior. ```css body { font-family: "Inter", "Segoe UI", sans-serif; font-size: 14px; line-height: 1.5; color: #e5e7eb; background: radial-gradient(circle at 20% 20%, rgba(59,130,246,0.08), transparent 35%), radial-gradient(circle at 80% 0%, rgba(94,234,212,0.07), transparent 40%), #0b1220; display: flex; gap: var(--space-lg); height: 100vh; padding: var(--space-lg); overflow: hidden; } ``` -------------------------------- ### Review a Git Diff Range Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use '--range HEAD~1..HEAD' to review a specific git diff range, which overrides working and staged changes. This provides a precise view of differences. ```bash lrc review --range HEAD~1..HEAD ``` -------------------------------- ### Skip Code Review Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Execute this command to bypass the code review process entirely for a commit. The git log will indicate that the review was skipped. ```bash git lrc review --skip ``` -------------------------------- ### Check Staged Diff Content Source: https://github.com/hexmostech/git-lrc/blob/main/docs/LRC_README.md Inspect the staged diff content to ensure it is correctly prepared for the LRC tool. ```bash git diff --staged ``` -------------------------------- ### Skip Review for a Commit Source: https://github.com/hexmostech/git-lrc/blob/main/README.md Use '--skip' to bypass the review process for a specific commit. This is useful for commits that do not require review or are intentionally excluded. ```bash lrc review --skip ``` -------------------------------- ### Re-enable All Git Hooks Source: https://github.com/hexmostech/git-lrc/blob/main/hooks/claude/SKILL.md Re-enables all Git hooks managed by lrc in the current repository. This action removes marker files under .git/lrc/. ```bash lrc hooks enable ```