GitScrum / Docs
Available for VS Code, Cursor, Windsurf, and any VS Code forkInstall from Marketplace

Quickstart

Install and start using GitScrum Studio in your code editor in under 2 minutes.


1. Install the Extension

Open the Extensions view (Ctrl+Shift+X / Cmd+Shift+X) and search for GitScrum Studio. Click Install.

Or install from the Command Palette:

Ctrl+Shift+P → ext install gitscrum-vscode.gitscrum-vscode

Works in VS Code, Cursor, Windsurf, and any VS Code fork. No restart required.


2. Sign In

  1. Click the GitScrum icon in the Activity Bar (left vertical strip)
  2. Click Sign in in the sidebar
  3. Choose your method: GitHub, Google, Facebook, or Email
  4. Complete authentication in the browser
  5. The extension connects automatically

Your token is stored securely in the editor's encrypted storage. You stay signed in across sessions.


3. Select Your Project

After signing in, the sidebar shows your workspaces:

  1. Expand a workspace to see its projects
  2. Click a project to set it as active
  3. The sidebar populates with Plan, Build, Knowledge, and Time Tracking sections

4. Open the Kanban Board

Click Board under the Build section in the sidebar. The Kanban board opens as an editor tab.

What you can do immediately:

  • Drag tasks between columns to update status
  • Click a task to open the task drawer with full editing
  • Create a task using the + button at the top of any column
  • Switch views between Kanban and List

5. Start Tracking Time

Click the clock icon in the status bar (bottom of the editor).

  1. Select ▶ Start Timer
  2. Choose a task from the list
  3. Work on your code
  4. Click the status bar timer → ⏹ Stop Timer
  5. Add an optional comment and save

The timer persists across editor restarts.


6. Explore More Features

Open any panel from the sidebar tree:

PanelWhat It Does
SprintsView sprint progress, burndown charts, team allocation
User StoriesBrowse feature backlog with acceptance criteria
Team StandupAsync standup: yesterday, today, blockers
WikiCreate and edit knowledge base pages
DiscussionsTeam chat organized by channels
DocumentsBrowse and download project files
Time TrackingView time log, charts, and team hours

All panels open as editor tabs. Split them side-by-side with your code.


Keyboard Quick Reference

ActionShortcut
Open ExtensionsCtrl+Shift+X / Cmd+Shift+X
Command PaletteCtrl+Shift+P / Cmd+Shift+P
All GitScrum commandsType GitScrum: in Command Palette
Close panelCtrl+W / Cmd+W
Custom shortcutsCtrl+K Ctrl+S / Cmd+K Cmd+S

Next Steps