Skip to content

Git Integration

Construct provides integrated Git-based storage for all projects, enabling version control and collaboration. This guide covers how to access and work with your project's Git repository.

Accessing the Git Repository

There are two ways to access your project's Git repository:

  1. Through Construct:

    • Click the Git icon in the left toolbar
    • You'll be taken to the repository view for your current context:
      • From a file: Opens that specific file in the repository
      • From a project: Opens the project's root directory
  2. Direct access:

Git repository interface

Repository Structure

Each Construct project has its own Git repository containing:

  • Circuit files (.circuit.json)
  • QRE analysis files (.qre-analysis.json)
  • Project configuration
  • Documentation and resources

Cloning Repositories

To work with repositories locally or in QDE:

  1. Click the Code button in the repository view
  2. Choose between HTTPS or SSH
  3. Copy the repository URL

Note

When using QDE, authentication is handled automatically. You don't need to set up additional credentials.

Local Development Setup

For local development outside QDE:

  1. Go to your profile settings
  2. Select Applications
  3. Create an access token:
    • Click Generate New Token
    • Give it a descriptive name
    • Select required permissions
    • Save the token securely

Use this token for authentication when cloning repositories locally.

Browsing Repositories

To view all available repositories:

  1. Click Explore in the top navigation
  2. Browse repositories you have access to
  3. Use the search and filter options to find specific projects

Development Workflow

When working with Git repositories:

  1. Create a new branch for your changes
  2. Make modifications through Construct tools
  3. Changes are automatically committed
  4. Use the Git interface to:
    • Review commit history
    • Browse file versions
    • Compare changes

Tip

While many Git operations are available through the interface, some advanced features are intentionally limited to maintain project consistency.

IDE Integration

The repository interface provides quick launch options for popular IDEs:

  • VS Code

Click the Code button and select your preferred IDE to open the project.

Note

Make sure you have the appropriate IDE installed locally when using these integration features.

Best Practices

  1. Create descriptive branch names
  2. Use project tools (Circuit Designer, Resource Analyzer) for primary development
  3. Leverage QDE for advanced development tasks
  4. Regularly sync changes when working locally

For more information about Developer Mode and advanced features, see Developer Features.