Docs
← Back to site Download

Projects

Projects are the foundation of VibeRails. Each project points to a local codebase directory and tracks its files, git history, and exclusion rules. Everything in VibeRails — reviews, issues, fixes — lives under a project.

Project Table Overview

The Projects screen lists every codebase you have registered with VibeRails. Each row shows the project name, its local path, file count, last-scanned timestamp, and a status indicator for uncommitted git changes.

Projects table showing registered codebases with file counts and status
The project table lists all registered codebases at a glance.

Columns can be sorted by clicking the header. The search bar at the top filters projects by name or path in real time. Use the checkbox column on the left to select multiple projects for batch operations.

Adding a Project

Click the Add Project button in the toolbar to open a native folder picker. Select any directory that contains source code — VibeRails will automatically detect the language breakdown and scan its file tree.

Tip: You can also drag-and-drop a folder directly onto the project table to add it instantly.

After adding a project, VibeRails performs an initial scan that indexes every file not excluded by your rules. Large monorepos may take a few seconds; a progress indicator appears in the project row during the scan.

Actions Menu

Right-click any project row (or click the overflow button) to open the actions menu. From here you can:

  • Rescan — re-index the file tree, picking up any new or removed files.
  • Edit Exclusion Rules — open the rules editor for this project.
  • Open in Terminal — launch a terminal window at the project root.
  • Open in Editor — open the project in your default code editor.
  • Remove — unregister the project from VibeRails (does not delete files on disk).
Context menu showing project actions like Rescan and Edit Rules
The actions menu provides quick access to common project operations.
Animated demo of project actions menu interactions
Walkthrough of common project actions.

Git Changes

If a project is inside a git repository, VibeRails monitors uncommitted changes and shows a summary badge on the project row. Click the badge to open the Changes Popover, which lists added, modified, and deleted files with a mini diff preview.

Tip: VibeRails watches the filesystem in real time. As you edit code in your editor, the changes badge updates automatically — no manual refresh needed.

Exclusion Rules

Exclusion rules control which files and directories VibeRails ignores during scans and reviews. Rules follow .gitignore glob syntax and are scoped per-project. VibeRails also respects your existing .gitignore automatically.

Open the exclusion rules editor from the actions menu or by clicking Edit Rules in the project details. The editor shows rules grouped by source:

  • Built-in — default rules for common noise like node_modules, .git, and build artefacts.
  • .gitignore — rules inherited from your repository's .gitignore file.
  • Custom — rules you have added manually in VibeRails.
Warning: Removing built-in exclusion rules (like node_modules) can dramatically increase scan times and review costs. Only do this if you specifically need those files reviewed.

Quick Exclude

When browsing files in a review or the file list, you can right-click any file or directory to Quick Exclude it. This adds a custom exclusion rule for the selected path and immediately removes it from future scans.

Batch Operations

Select multiple projects using the checkboxes in the first column, then use the batch toolbar that appears above the table. Batch operations include:

  • Rescan All — re-index all selected projects in parallel.
  • Remove All — unregister all selected projects (with confirmation).
  • Export — export project metadata and issue history for the selected projects.
Tip: Use Shift+click to select a range of projects, or Cmd+click (macOS) / Ctrl+click (Windows/Linux) to toggle individual selections.