Back to docs

Installation

Install the Opentix VS Code extension and verify it's working.

Prerequisites

Before installing Opentix, make sure you have:

  • A VS Code-based IDE (1.85 or newer) — see supported IDEs below
  • Git installed and configured (git config user.name and git config user.email should be set)
  • A Git repository (local or with a remote) to use Opentix in

Install the Extension

Opentix works with any IDE built on VS Code. You can get it from the Visual Studio Code Marketplace, or install it directly for your IDE:

Or install from the command line:

code --install-extension jpmadrigal07.opentix

For web-based IDEs like Eclipse Theia, Gitpod, and Code-Server, search for "Opentix" in the IDE's built-in extension view or install via the CLI within your environment.

Verify Installation

After installing, open a Git repository in VS Code and open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P). You should see the Opentix commands:

  • Opentix: Initialize Project
  • Opentix: Open Board
  • Opentix: Create Ticket
  • Opentix: Sync Tickets

If these commands appear, Opentix is installed and ready to use.

Note: Opentix does not create any files or directories until you explicitly run Opentix: Initialize Project. Opening a repository with the extension installed is completely non-invasive — the status bar will show "Opentix (init)" to indicate the project has not been initialized yet.

Quick Start

  1. Open a Git repository in VS Code
  2. Run Opentix: Initialize Project from the Command Palette
  3. Choose "Use recommended settings" for a fast setup, or "Customize settings" to configure each option
  4. Run Opentix: Open Board to see the Kanban board
  5. Create your first ticket with the "+ New Ticket" button on the board

Next Steps