GitHub Codespace

You can set this up automatically from your Personal Account page using the Install in repository button (recommended), or follow the manual steps below.

Installation Manual: QOps in GitHub Codespace

1. Go to your repository (e.g., https://github.com/your-username/your-repo).
2. Create a .devcontainer directory in the root of the repository and add a devcontainer.json file inside it.

Example devcontainer.json content:

{
  "image": "qopsimages/qops:latest",
  "containerEnv": {
    "QOPS_LICENSE_KEY": "${localEnv:QOPS_LICENSE_KEY}"
  },
  "customizations": {
    "vscode": {
      "extensions": ["dvstseood.qlik-ext"],
      "settings": { "qops.defaultShell": "pwsh" }
    }
  },
  "postCreateCommand": "curl -sL https://raw.githubusercontent.com/qops-hub/codespace-scripts/main/post-create.sh | bash"
}

3. Add your QOps license key as a Codespace secret:
   1. Go to the ⚙️ Settings tab in your repository.
   2. Expand Secrets and variables → Codespaces.
   3. Click New repository secret.
   4. Set the name as QOPS_LICENSE_KEY.
   5. Paste your license key and click Add secret.
4. Go back to the Code tab and click the green Code button.
5. Open the Codespaces tab and click Create codespace on main.
6. Wait for your Codespace to build.
7. In the Terminal tab, pwsh should open automatically (configured via qops.defaultShell).
8. (Optional) Run QOps-Version to check the module version.

You are now ready to use QOps in your GitHub Codespace.

The repository is ready when the Portal starts

In a GitHub Codespace, QOps-StartPortal registers the repository the Codespace was opened on, so the Portal and the AI assistant list it without Add repository. When your QOps configuration has no default profile yet, an empty one is added for you to fill in with your Qlik connection. Outside a Codespace nothing changes.