First Steps
Set up your workspace and start discovering projects with Astrolabe
Welcome to Astrolabe! This guide will walk you through the initial setup and help you start managing your development projects.
Add Scan Directories
Astrolabe discovers projects by scanning directories on your system. Start by adding the folders where you keep your projects.
- Click Settings in the sidebar (⚙️ icon)
- Navigate to the Scanner tab
- Click Add Directory
- Select a folder containing your projects (e.g.,
~/projects,~/code,~/dev)
Recommended Directories:
~/projects- Personal projects~/work- Work-related projects~/code- General code folder~/Desktop- Projects on desktop (if applicable)
Scan Depth
By default, Astrolabe scans up to 3 levels deep. You can adjust this in the scanner settings. For monorepos, increase the depth to ensure all packages are discovered.
Advanced Options:
- Recursive Scanning: Enable to scan subdirectories
- Max Depth: How many levels deep to scan (default: 3)
- Exclude Patterns: Skip directories like
node_modules,.git,target
Run Your First Scan
Once you've added directories, it's time to discover your projects!
- Click the Scan button in Settings → Scanner
- Wait while Astrolabe discovers your projects (this may take 1-5 minutes depending on the number of directories)
- Watch the progress indicator as projects are detected
The first scan may take longer as Astrolabe analyzes each project's tech stack, frameworks, and git status.
What Astrolabe Detects:
- Languages: JavaScript/TypeScript, Rust, Python, Go, Java, Ruby, PHP, etc.
- Frameworks: Next.js, React, Vue, Svelte, Tauri, Django, Laravel, and more
- Package Managers: npm, pnpm, yarn, bun, cargo, pip, go mod, etc.
- Git Status: Branch, commit info, clean/dirty status
Explore Your Projects
After scanning completes, you'll see all discovered projects in the main view.
View Modes
Switch between different views based on your preference:
- Grid View - Visual cards with project info
- List View - Compact list format
- Table View - Detailed table with sortable columns
Filter Projects
Use the filters to narrow down what you see:
- Search - Fuzzy search by project name (Cmd/Ctrl+F)
- Language - Filter by programming language
- Framework - Filter by framework
- Git Status - Show only dirty/clean repos
- Folder - View projects in specific folders
Quick Actions
Click any project card to see quick actions:
- Open in Editor - Launch in VS Code (configurable)
- Open in Finder/Explorer - View project files
- View Details - See full project information
- Terminal - Open terminal in project directory
Organize with Folders
Keep your projects organized by creating folders and moving projects into them.
Create a Folder
- Click the + button in the sidebar under "Folders"
- Enter a name (e.g., "Work Projects", "Personal", "Archived")
- (Optional) Choose a color for the folder
Move Projects
Drag and drop projects from the main view into folders in the sidebar.
Or use bulk operations:
- Select multiple projects (hold Cmd/Ctrl and click)
- Click Move to Folder in the top toolbar
- Choose the destination folder
Projects can only be in one folder at a time, but you can use tags for multiple categorizations.
Add Tags (Optional)
Tags provide flexible categorization across folders. Create tags for:
- Project types (frontend, backend, fullstack)
- Technologies (react, rust, python)
- Status (active, archived, experimental)
- Clients or teams
Create a Tag
- Go to Settings → Tags
- Click New Tag
- Enter a name and choose a color
- Save the tag
Assign Tags
- Open a project detail view
- Click Add Tag
- Select from your existing tags
Configure Quick Access
Set up your preferred editor and shell for quick access.
- Go to Settings → General
- Default Editor: Choose VS Code, VS Code Insiders, Cursor, or custom
- Default Shell: Select zsh, bash, fish, or custom
- Terminal Theme: Choose from available Ghostty themes
Astrolabe will auto-detect VS Code and common editors. If using a custom editor, provide the full path to the executable.
What's Next?
Project Browser
Learn about filtering, sorting, and viewing projects
Git Integration
Manage repositories, branches, and commits
Organization
Advanced folder, tag, and rule features
Terminal
Use the embedded terminal and run dev servers
Tips for Success
- Regular Scans: Re-scan periodically to pick up new projects
- Use Tags Liberally: Tags help you find projects quickly
- Keyboard Shortcuts: Use Cmd+K (Ctrl+K) to open the command palette
- Backup Your Data: Your database is in
~/Library/Application Support/com.astrolabe.app/(macOS)
Need help? Check out the FAQs or Troubleshooting Guide.