Skip to main content

Quick Start

Get up and running with Friday Dev in 5 minutes.

Step 1: Launch Friday Dev​

npx friday-dev

Your browser will open to http://localhost:3000 with the Friday Dev dashboard.

Step 2: Create a Project​

  1. Click "New Project" on the dashboard
  2. Enter a project name (e.g., "My First Project")
  3. Select a local folder or Git repository
  4. Click "Create"

Step 3: Create Your First Task​

Using the UI​

  1. Open your project
  2. Click the "+" button
  3. Enter task details:
    • Title: "Build login page"
    • Description: "Create a responsive login page with email and password fields"
    • Priority: High
  4. Click "Create Task"

Using Voice (Optional)​

  1. Click the microphone icon
  2. Say: "Create a new task to build a login page with high priority"
  3. Friday will create the task automatically

Step 4: Run an AI Agent​

  1. Click on your task to open it
  2. Click "Run Agent"
  3. Select an AI agent:
    • Friday Agent (Recommended) - Best for complex tasks
    • Gemini - Fast and efficient
    • Claude - Detailed and safe
  4. Click "Start"

The AI will:

  • Analyze your task
  • Write the code
  • Create a PR (if connected to Git)
  • Update the task status

Step 5: Review the Output​

After the agent completes:

  1. View Logs - See what the AI did step by step
  2. View Diffs - Review code changes
  3. Approve/Reject - Accept or request changes

Example Workflow​

┌─────────────────────────────────────────────────────────┐
│  1. Create Task                                          │
│     "Add user authentication to the app"                │
├─────────────────────────────────────────────────────────┤
│  2. Run Friday Agent                                     │
│     Agent analyzes codebase and plans implementation    │
├─────────────────────────────────────────────────────────┤
│  3. AI Writes Code                                       │
│     - Creates auth service                              │
│     - Adds login/register routes                        │
│     - Updates database schema                           │
├─────────────────────────────────────────────────────────┤
│  4. Review & Approve                                     │
│     You review the changes and approve                  │
├─────────────────────────────────────────────────────────┤
│  5. Task Complete                                        │
│     Code is merged, task marked as done                 │
└─────────────────────────────────────────────────────────┘

CLI Quick Start​

You can also use Friday Dev from the command line:

# Create a task
friday-dev task create "Build login page" --priority high

# List tasks
friday-dev task list

# Run an agent on a task
friday-dev run --task 123 --agent friday

# Code review
friday-dev review pr 456

Keyboard Shortcuts​

ShortcutAction
Ctrl/Cmd + NNew task
Ctrl/Cmd + KQuick search
Ctrl/Cmd + /Toggle sidebar
Ctrl/Cmd + EnterRun agent
EscClose modal

Next Steps​