/Docs

Installation

This guide covers all installation methods for Qommity, from the CLI tool to GitHub App integration and environment configuration.

Install the CLI

Using npm

bash
1
npm install -g @qommity/cli

Using yarn

bash
1
yarn global add @qommity/cli

Using pnpm

bash
1
pnpm add -g @qommity/cli

Using npx (no install)

bash
1
npx @qommity/cli <command>

System Requirements

  • Node.js 18.0 or later
  • Git 2.20 or later
  • A valid Qommity API key

GitHub App Setup

To enable automatic deployment tracking and PR analysis, install the Qommity GitHub App on your repositories:

  1. 1Go to github.com/apps/qommity
  2. 2Click "Install" and select your organization
  3. 3Choose "All repositories" or select specific ones
  4. 4Grant the requested permissions

Required Permissions

Repository contents

Read access to analyze code changes

Pull requests

Read and write for PR comments

Commit statuses

Read to track deployment status

Webhooks

Receive push and PR events

Environment Variables

Configure these environment variables in your deployment environment:

.env
bash
1
2
3
4
5
6
7
8
9
# Required
QOMMITY_API_KEY=your_api_key_here


# Optional - auto-detected if not set
QOMMITY_PROJECT_ID=proj_abc123
QOMMITY_ENVIRONMENT=production


# Optional - for self-hosted instances
QOMMITY_API_URL=https://api.qommity.com

CI/CD Environment Variables

For GitHub Actions, add your API key as a repository secret:

  1. 1Go to your repository on GitHub
  2. 2Navigate to Settings > Secrets and variables > Actions
  3. 3Click "New repository secret"
  4. 4Name: QOMMITY_API_KEY, Value: your API key
.github/workflows/deploy.yml
yaml
1
2
3
4
5
6
- name: Deploy to production
  run: |
    qommity deploy
    # Your deploy commands here
  env:
    QOMMITY_API_KEY: ${{ secrets.QOMMITY_API_KEY }}

Verification

Verify your installation by running the following commands:

Check CLI Version

bash
1
qommity --version

Expected output: @qommity/cli/1.2.3

Verify Configuration

bash
1
qommity config verify

This validates your API key and project configuration.

Test Deployment Tracking

bash
1
qommity deploy --dry-run
All Systems Go

If all commands return successfully, you are ready to start tracking deployments with Qommity.

Troubleshooting

API key not found

Ensure QOMMITY_API_KEY is set in your environment or .env file. Run 'qommity config verify' to check.

Permission denied errors

Verify the GitHub App is installed on the repository and has the required permissions.

Command not found

Ensure the CLI is installed globally and your npm/yarn global bin directory is in your PATH.

Still having issues? Contact support or check our configuration guide.