Skip to main content
Polaris provides comprehensive project management features, allowing you to create new projects, import from GitHub, organize your work, and configure project settings.

​
Project Dashboard

The project dashboard is your starting point in Polaris, displaying all your projects in one place.

​
Accessing the Dashboard

Navigate to /projects to view your project dashboard featuring:
  • Project list - All your projects with status indicators
  • Quick actions - Create new or import projects
  • Search - Find projects quickly with Command Palette

​
Quick Actions

The dashboard provides two primary actions:

New Project

Create a project from scratch using AI assistanceKeyboard: ⌘J (Mac) or Ctrl+J (Windows/Linux)

Import from GitHub

Clone a repository from GitHub into PolarisKeyboard: ⌘I (Mac) or Ctrl+I (Windows/Linux)

​
Creating Projects

​
AI-Assisted Project Creation

Create projects by describing what you want to build:
1

Open New Project dialog

Click “New” or press ⌘J / Ctrl+J
2

Describe your project

Enter a natural language description:
Create a portfolio website with a hero section, about page, and contact form

Build a todo app with React and local storage

Set up a REST API with Express and MongoDB
3

Let AI generate the project

Polaris will:
  • Generate a project name
  • Create initial file structure
  • Write starter code based on your description
  • Set up appropriate dependencies
4

Start building

You’ll be automatically redirected to your new project
Be specific in your project description. Include technologies, features, and structure you want. The AI will use this to scaffold your project appropriately.

​
Import from GitHub

Bring existing repositories into Polaris:
1

Open Import dialog

Click “Import” or press ⌘I / Ctrl+I
2

Enter GitHub URL

Provide the full repository URL:
https://github.com/username/repository
3

Start import

Polaris will clone the repository:
  • Fetches all files and folders
  • Preserves directory structure
  • Imports all file contents
  • Shows import progress
4

Wait for completion

Import status indicators:
  • Importing - Clone in progress (spinner icon)
  • Completed - Ready to use (GitHub icon)
  • Failed - Error occurred (alert icon)
Imported projects maintain their original structure but are stored in Polaris’s database, not connected to the original Git repository.

​
Project List

Your projects are displayed on the dashboard with relevant information:

​
Project Status Indicators

Each project displays an icon indicating its source:

GitHub Import

Project was imported from a GitHub repository

Importing

GitHub import currently in progress

Created in Polaris

Project created directly in Polaris

​
Import Error Handling

If a GitHub import fails:
  • Project shows with an alert icon
  • Error status is displayed
  • You can retry the import or delete the project

​
Command Palette

Quickly search and navigate to any project:
1

Open Command Palette

Press ⌘K (Mac) or Ctrl+K (Windows/Linux)
2

Search projects

Type to filter your project list by name
3

Select project

Click or press Enter to open the selected project
The Command Palette searches project names and IDs, making it easy to find projects even if you don’t remember the exact name.

​
Project Settings

​
Renaming Projects

Update your project name to stay organized:
1

Open project

Navigate to the project you want to rename
2

Access settings

Click the project name in the navigation bar
3

Edit name

Enter the new name and save
Project names are for organization only and don’t affect the functionality or file structure.

​
Project Workspace

When you open a project, you enter the full development environment:

​
Workspace Layout

The project workspace is divided into three main areas:

File Explorer

Left sidebar showing your project’s file structure

Code Editor

Central area with tabs for editing files

AI Assistant

Right sidebar for conversational help
The top navigation provides:
  • Project name - Current project identifier
  • Settings access - Project configuration
  • Export options - Save work externally

​
Exporting Projects

Save your work outside of Polaris:

​
Export to GitHub

Push your project to a GitHub repository:
1

Open export menu

Click the export button in the navigation
2

Select GitHub export

Choose “Export to GitHub” option
3

Configure repository

  • Provide repository details
  • Set visibility (public/private)
  • Add description
4

Confirm export

Your project files will be pushed to the new GitHub repository
You’ll need to authenticate with GitHub to export projects. The export creates a new repository or updates an existing one.

​
Keyboard Shortcuts

​
Dashboard

ShortcutAction
⌘K / Ctrl+KOpen Command Palette (search projects)
⌘J / Ctrl+JCreate new project
⌘I / Ctrl+IImport from GitHub

​
Project View

ShortcutAction
⌘K / Ctrl+KSearch files and commands
⌘S / Ctrl+SSave current file (auto-save enabled)

​
Best Practices

Descriptive Names

Use clear, descriptive project names to easily identify projects

Organize Files

Create a logical folder structure as your project grows

Use Conversations

Keep different features or fixes in separate AI conversations

Regular Exports

Export to GitHub regularly to back up your work

​
Project Metadata

Each project automatically tracks:
  • Creation time - When the project was created
  • Last updated - Most recent modification timestamp
  • Import status - For GitHub imports
  • Owner - Project creator

​
Automatic Updates

Projects are automatically updated when:
  • Files are created, modified, or deleted
  • Project settings are changed
  • Conversations are created
This keeps your “Last updated” timestamp accurate without manual intervention.

​
Optimistic UI Updates

Project operations feel instant with optimistic updates:
  • Create project - Appears in list immediately
  • Rename project - Name changes instantly
  • Import progress - Status updates in real-time
The UI updates before the server confirms changes, then syncs in the background for a smooth experience.

​
Limitations

  • Projects cannot currently be deleted from the UI
  • GitHub imports are one-time operations (not continuous sync)
  • Project names must be unique per user
  • Large repositories may take time to import

​
Project Capacity

Polaris projects support:
  • Unlimited files and folders
  • Files of any text-based format
  • Multiple concurrent conversations
  • Full project history

Build docs developers (and LLMs) love

Get started for freeTalk to us