Projects
Projects are top-level containers that help you organize related applications.
Overview
Section titled “Overview”A project represents a logical grouping of applications. For example:
- A company might have projects for different products
- A developer might have projects for personal, client, and open-source work
- Teams might organize projects by department or initiative
Creating a Project
Section titled “Creating a Project”Create a new project with a unique slug:
brdz projects:create my-projectThe slug must be:
- Unique across your account
- URL-safe (lowercase letters, numbers, hyphens)
- Descriptive and easy to remember
Example
Section titled “Example”# Create a project for a web applicationbrdz projects:create web-platform
# Create a project for mobile appsbrdz projects:create mobile-apps
# Create a personal projectbrdz projects:create personal-siteListing Projects
Section titled “Listing Projects”View all your projects:
brdz projects:listOutput example:
ID Name Created At1 web-platform 2025-01-15 10:30:002 mobile-apps 2025-01-16 14:20:003 personal-site 2025-01-17 09:15:00Getting Project Details
Section titled “Getting Project Details”Get detailed information about a specific project:
brdz projects:get my-projectOutput includes:
- Project ID
- Name/slug
- Creation timestamp
- Associated apps (if any)
Project Membership
Section titled “Project Membership”Projects support team collaboration through membership:
- Projects can have multiple members
- Members can manage apps within the project
- Access control ensures users can only access their authorized projects
Working with Projects
Section titled “Working with Projects”Setting Project Context
Section titled “Setting Project Context”After creating a project, set it as your current context:
brdz ctx:useThis allows subsequent commands to use this project without specifying it each time.
Creating Apps in a Project
Section titled “Creating Apps in a Project”Once your project context is set, create apps:
# Set context firstbrdz ctx:use
# Create an app in the current projectbrdz apps:create my-appUse Cases
Section titled “Use Cases”Multiple Environments
Section titled “Multiple Environments”Create separate projects for different environments:
brdz projects:create productionbrdz projects:create stagingbrdz projects:create developmentClient Work
Section titled “Client Work”Organize projects by client:
brdz projects:create client-acmebrdz projects:create client-globexbrdz projects:create client-initechProduct Lines
Section titled “Product Lines”Separate projects for different products:
brdz projects:create marketing-sitebrdz projects:create dashboardbrdz projects:create api-docsBest Practices
Section titled “Best Practices”- Use descriptive names - Choose clear, meaningful project slugs
- Organize logically - Group related apps in the same project
- Set context early - Run
ctx:useafter creating a project - Plan your structure - Think about how you’ll organize projects before creating them
Limitations
Section titled “Limitations”- Project slugs must be unique within your account
- Project slugs cannot be changed after creation
- Deleting a project requires deleting all apps within it first
Commands Reference
Section titled “Commands Reference”projects:create <slug>
Section titled “projects:create <slug>”Create a new project.
Arguments:
slug- Unique project identifier (required)
Example:
brdz projects:create my-projectprojects:list
Section titled “projects:list”List all projects in your account.
Example:
brdz projects:listprojects:get <slug>
Section titled “projects:get <slug>”Get detailed information about a project.
Arguments:
slug- Project identifier (required)
Example:
brdz projects:get my-projectRelated Topics
Section titled “Related Topics”- Apps - Creating and managing apps within projects
- Context Management - Setting project context
- Core Concepts: Projects - Understanding project architecture