Skip to content

pipeline sync

Overview

Synchronize your local pipeline to Quix Cloud

Aliases: sync, deploy

Usage:

quix pipeline sync [options]

Options:

  • --workspace-id <workspace-id> : Select a concrete workspace-id to sync to
  • --directory <directory> : Base directory (defaults to current directory)
  • -u, --update : Update 'quix.yaml' with the new local applications and update the variables of the existing deployments
  • -m, --commit-message <commit-message> : The message used for the commit if using '--push'

How It Works

When you execute this command, it synchronizes your local pipeline to Quix Cloud. The command checks for any commits that exist locally but not remotely, remotely but not locally, and any differences in content between the branches.

If your local repository is in sync with the remote, the command will:

  1. Add Files: Stages all the changes in your local repository.
  2. Commit Changes: Commits the staged changes to the local repository.
  3. Push to Remote: Pushes the committed changes to the remote repository.
  4. Sync Environment: Synchronizes your environment in Quix Cloud.

Warning

You need to be logged in to Quix Cloud for the environment sync to happen.

Example usage

Basic Synchronization

To synchronize your local pipeline to Quix Cloud without any additional options, use:

$ quix pipeline sync

Tip

Using the --update option will perform the same actions as running quix pipeline update before syncing.

This command stages all changes in your local repository:

Sending all changes to git ...

Then, it commits the staged changes:

Executing commit ...

Add a Commit Message

Use the --commit-message option to include a meaningful commit message, making it easier to track changes:

$ quix pipeline sync --commit-message "Initial deployment to Quix Cloud"

Finally, after it pushes the committed changes to the remote repository:

✓ Sync completed

Tip

If you see the message:

✗ Your local repository is out of sync with the remote, please push your changes manually"
  • Your local branch has commits not yet pushed to the remote.
  • The remote branch has commits not yet pulled into your local repository.
  • There are uncommitted changes in your local files that differ from the remote.

This indicates that your local and remote repositories are not aligned. You need to manually push your local changes to the remote to synchronize them.