codedb:getting-started
Table of Contents
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
- Download CodeDB from the Mac App Store
- Once installed, open CodeDB from your Applications folder or Launchpad
- 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
- Click the + button in the Explorer section header
- Enter a file name with extension (e.g.,
main.py,app.js) - 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
- Open a file in the editor
- Press โR or use the Relations panel at the bottom
- Click Add Relation and select the target file
- Choose a relation type (e.g.,
imports,depends_on,related_to)
See Relations & Dependencies for full details.
4. Run a Query
- Press โJ to open the bottom panel
- Click the Query Console tab
- Write SQL against the CodeDB database (tables:
files,relations,tags,properties) - Click Run to see results
See Query Console for full details.
5. Visualize Your Graph
- Open the Graph tab in the bottom panel
- See your files as nodes connected by their relationships
- 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)
