LogoLogo
RedBrick AIGuides
  • Quick Start
    • Walkthrough Guides
    • Get Started with a Project
    • Get Started with Workspace
      • Cohort Creation
      • Datapoint Classification
      • Configuring Metadata Schema
    • Creating a RedBrick AI Account
  • Organizations
    • Organization and Project Roles
    • Inviting Your Team
      • Single Sign-on
  • Dashboard
    • Account Settings
    • User Preferences
    • Worklist
    • Preview Tool
    • Integrations
    • Taxonomies
    • Boost
      • Auto Annotator
    • Home
      • Sections
  • Importing Data
    • Uploading Data to RedBrick
    • Import Cloud Data
      • Configuring AWS s3
      • Configuring Azure Blob
      • Configuring GCS
      • Configuring AltaDB
      • Creating an Items List
    • Troubleshooting
  • Projects
    • Tasks & Assignment
    • Comments & Raise Issue
    • Reference Standards
    • Project & Task Analytics
    • Labeler Evaluation
  • Project Pages
    • Data Page
    • Settings Page
      • Custom Label Validation
      • Custom Hanging Protocol
      • Webhooks
    • Multiple Labeling
      • Consensus
        • Agreement calculation
      • Task duplication
  • Annotation & viewer
    • Viewer Basics
      • Document Viewer
      • Multiple Modalities
      • Intellisync
      • Annotation Mirroring
    • Creating, Editing and Deleting Annotations
    • Visualization and Masking
    • Segmentation
      • Segmentation Tools
      • Instance vs. Semantic
      • Overlapping Segmentations
    • Heat maps
  • Python SDK & CLI
    • Full documentation
    • Installation & API Keys
    • SDK Overview
      • Importing Data & Annotations
      • Programmatic Label & Review
      • Assigning & Querying Tasks
      • Exporting Annotations
    • CLI Overview
      • Creating & Cloning Projects
      • Import Data & Annotations
      • Exporting Annotations
    • Importing Annotations Guide
    • Formats
      • Full Format Reference
      • Export Structure
  • Useful Links
    • Privacy Policy
Powered by GitBook
On this page
  • Creating a new project
  • Clone an existing project

Was this helpful?

  1. Python SDK & CLI
  2. CLI Overview

Creating & Cloning Projects

Almost all CLI operations need to be performed within a local project directory. A local project directory can be created by cloning a RedBrick AI project, or by creating a new project using the CLI.

Creating a new project

To create a new project, first navigate to an empty directory. We recommend creating a new directory, and naming it after your new project.

$ mkdir my-new-project
$ cd my-new-project

Now to create a new project, simply run:

$ redbrick init
> Name: my-new-project
> Taxonomy: my-taxonomy-name
> Reviews: 1

You can now verify your current directory is a local project directory by doing:

$ redbrick info
                 Organization                  
╭──────┬──────────────────────────────────────╮
│ ID   │               ...                    │
│ Name │ My Organization                      │
╰──────┴──────────────────────────────────────╯
                                    Project                                     
╭──────────┬───────────────────────────────────────────────────────────────────╮
│ ID       │ ...                                                               │
│ Name     │ my-new-project                                                    │
│ Taxonomy │ my-taxonomy-name                                                  │
│ URL      │ https://app.redbrickai.com/.../projects/.../                      │
╰──────────┴───────────────────────────────────────────────────────────────────╯

Clone an existing project

You can clone an existing project that you (or someone else) created.

$ redbrick clone 
> Project: 
❯ 3/3
❯ my-new-project (...)
  my-first-project (...)
  my-old-project (...)

You can directly clone a project using it's project ID.

$ redbrick clone PROJECTID # replace PROJECTID with your project's ID

The project will now be cloned in a directory named after your project (within your current working directory).

PreviousCLI OverviewNextImport Data & Annotations

Last updated 2 years ago

Was this helpful?