Docs
Docs / Projects

Projects

A project groups related code, deployments, environments and members together. Every resource in your account belongs to exactly one project.

Overview

Projects are the main unit of organisation. Each project has its own settings, access controls, environment variables and deployment history. You can create as many projects as you need, and move resources between them at any time.

Tip: Use one project per service or application. Shared libraries can live in their own project and be referenced from others.

Creating a project

From the command line, run:

docs projects create my-service \
  --region eu-west-1 \
  --visibility private

Project names must be lowercase, may contain hyphens, and must be unique within your account.

Browse projects

The table below lists sample projects in this account. Filter by name or status.

Name Status Region Tags Updated
checkout-apiActiveeu-west-1backendpayments2 hours ago
web-storefrontActiveeu-west-1frontendyesterday
legacy-reportsPausedus-east-1internal3 weeks ago
search-indexerActiveus-east-1backenddata5 days ago
mobile-prototype-v1Archivedeu-west-1mobilelast year
docs-siteActiveeu-west-1frontenddocsjust now

No projects match your filter.

Project settings

Each project exposes the following settings under Project → Settings:

SettingDefaultDescription
visibilityprivateWho can see the project. One of private, team, or public.
regionAccount defaultWhere build and runtime resources are provisioned.
retention_days30How long deployment logs are kept.
archive_on_deletetrueKeep a read-only copy when the project is deleted.

Archiving and deleting

Archiving a project stops all deployments and makes it read-only. Archived projects can be restored within 90 days. Deleting a project is permanent and removes all associated resources.

docs projects archive my-service
docs projects restore my-service
docs projects delete my-service --confirm

Next steps