/Docs

Getting Started

This guide will walk you through setting up Qommity in your project and tracking your first deployment. You will be up and running in under 5 minutes.

Prerequisites

Before you begin, make sure you have the following:

  • Node.js 18+ or Python 3.9+ installed
  • A GitHub, GitLab, or Bitbucket repository
  • A Qommity account (sign up at qommity.com)
  • Your API key from the Qommity dashboard
1

Install the CLI

Install the Qommity CLI globally using npm or yarn:

bash
1
npm install -g @qommity/cli

Or use yarn:

bash
1
yarn global add @qommity/cli

Verify the installation:

bash
1
qommity --version
2

Initialize Your Project

Navigate to your project directory and run the init command:

bash
1
2
cd your-project
qommity init

The CLI will prompt you for your API key and guide you through the setup. This creates a qommity.config.json file in your project:

qommity.config.json
json
1
2
3
4
5
6
7
8
9
10
{
  "projectId": "proj_abc123",
  "apiKey": "${QOMMITY_API_KEY}",
  "environment": "production",
  "repository": {
    "provider": "github",
    "owner": "your-org",
    "name": "your-repo"
  }
}
3

Track Your First Deployment

Once configured, track a deployment by running:

bash
1
qommity deploy

The CLI automatically detects your git commit and branch. You can also specify them explicitly:

bash
1
qommity deploy --commit abc123 --branch main --version 1.2.3
Success

Your deployment is now being tracked! You will see it appear in the Qommity dashboard within seconds.

4

Integrate with Your CI/CD

Add Qommity to your CI/CD pipeline to automatically track every deployment. Here is an example for GitHub Actions:

.github/workflows/deploy.yml
yaml
1
2
3
4
- name: Track deployment
  run: qommity deploy
  env:
    QOMMITY_API_KEY: ${{ secrets.QOMMITY_API_KEY }}

Next Steps

Now that you have Qommity set up, explore these topics to get the most out of the platform: