Skip to content

Projects

Projects are the top-level containers in FuncSpec. Each project holds a set of functional and technical specifications, a team, and its own configuration.

Creating a Project

Via Web Interface

  1. From your organization dashboard, click New Project
  2. Fill in the project details:
  3. Name: Human-readable project name (e.g., "Payments Service")
  4. Description: Brief overview of what this project covers
  5. Slug: URL-friendly identifier — auto-generated from the name, but editable
  6. Click Create Project

The new project opens immediately on its dashboard.

Via CLI

funcspec projects create "Payments Service" \
  --description "Stripe integration and billing workflows"

Via API

curl -X POST https://funcspec.net/api/v1/projects \
  -H "X-Api-Key: $FUNCSPEC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Payments Service",
    "description": "Stripe integration and billing workflows"
  }'

Slug-Based URLs

Every project has a slug that forms part of its URL:

https://funcspec.net/acme/payments-service

The URL structure is /{org-slug}/{project-slug}. Slugs:

  • Are lowercase and hyphenated
  • Must be unique within your organization
  • Are set at creation and cannot be changed — changing a slug would break existing links and integrations

Warning

Choose your project slug carefully. It is permanent.

Project Dashboard

The project dashboard gives you an at-a-glance view of project health:

  • Spec count: Total functional and technical items, broken down by state
  • Implementation status: What percentage of accepted specs are implemented
  • Recent activity: Latest changes by team members
  • AI review coverage: How many items have been reviewed

From the dashboard you can navigate to:

Section Description
Spec Items Browse and manage all specifications
Dependencies Visual dependency graph between items
Inbox Items awaiting triage
Export Download documentation in various formats
Settings Project configuration
Audit Log Full history of project changes
Usage AI operation and API usage metrics

Project Settings

Access settings via Project → Settings.

General

  • Name and Description: Editable at any time
  • Default item type: Whether new items default to Functional or Technical
  • GitHub Integration: Link a GitHub repository for code audit features

Team

Manage who has access to the project. See Collaboration for details on roles and permissions.

AI Configuration

Configure the AI model used for this project's AI operations:

  • Provider: OpenAI, Anthropic, or custom endpoint
  • Model: Choose from available models (e.g., gpt-4o, claude-opus-4-5)
  • API Key: Use your own key (BYOK) or the platform default

Tip

BYOK (Bring Your Own Key) lets you use your existing AI contracts and quotas. See AI Features for setup instructions.

GitHub Integration

Connect a GitHub repository to enable:

  • Code Audit: Check whether specs are reflected in the actual codebase
  • Repository context: AI features can reference your source code

To connect:

  1. Go to Project Settings → GitHub Integration
  2. Click Connect Repository
  3. Authorize the FuncSpec GitHub App
  4. Select the repository

Editing a Project

From Project Settings → General:

  1. Update the Name or Description
  2. Click Save Changes

Via CLI:

funcspec projects update payments-service \
  --name "Payments & Billing" \
  --description "Updated description"

Deleting a Project

Danger

Deleting a project permanently removes all spec items, AI reviews, dependency edges, and history. This cannot be undone.

Via Web Interface

  1. Go to Project Settings → General
  2. Scroll to the Danger Zone
  3. Click Delete Project
  4. Type the project slug to confirm

Via CLI

funcspec projects delete payments-service --confirm

Use the top navigation to switch between projects. The sidebar shows project-specific sections. You can also use the global search (/ keyboard shortcut) to jump to any item across all projects.

Next Steps