User Tools

Site Tools


codedb:getting-started

Getting Started with CodeDB

System Requirements

  • macOS Version: macOS 13.0 (Ventura) or later
  • Architecture: Apple Silicon (M1/M2/M3/M4) and Intel
  • Storage: Minimum 100 MB available space

Installation

  1. Download CodeDB from the Mac App Store
  2. Once installed, open CodeDB from your Applications folder or Launchpad
  3. CodeDB stores its database at ~/Library/Application Support/CodeDB/relationcode.db

First Launch

When you first open CodeDB, you'll see the main workspace with three areas:

  • Sidebar (left) โ€” File explorer, Smart Views, and Tags
  • Editor (center) โ€” Code editor with tabbed files
  • Bottom Panel โ€” Relations, Properties, Query Console, Impact Analysis, and Graph

The welcome screen shows available keyboard shortcuts to get you started quickly.

Quick Start Guide

1. Create Your First File

  1. Click the + button in the Explorer section header
  2. Enter a file name with extension (e.g., main.py, app.js)
  3. The file opens in the editor with syntax highlighting based on the extension

2. Import Existing Files

You can import files two ways:

  • Single files: Click the file icon (๐Ÿ“„) in the Explorer header to select individual files
  • Folder import: Click the folder icon (๐Ÿ“‚) to import an entire directory

CodeDB supports files up to 50 MB, including large CSV and TSV datasets.

3. Add a Relationship

  1. Open a file in the editor
  2. Press โŒ˜R or use the Relations panel at the bottom
  3. Click Add Relation and select the target file
  4. Choose a relation type (e.g., imports, depends_on, related_to)

See Relations & Dependencies for full details.

4. Run a Query

  1. Press โŒ˜J to open the bottom panel
  2. Click the Query Console tab
  3. Write SQL against the CodeDB database (tables: files, relations, tags, properties)
  4. Click Run to see results

See Query Console for full details.

5. Visualize Your Graph

  1. Open the Graph tab in the bottom panel
  2. See your files as nodes connected by their relationships
  3. Drag nodes to rearrange, zoom to explore

See Impact Analysis & Graph for full details.

Tip: Use โŒ˜P to open the Command Palette at any time. It lets you quickly open files, run commands, and navigate your workspace.

codedb/getting-started.txt ยท Last modified: (external edit)