testapilocally.com

Signoff Studio Docs

Install

Get Signoff Studio running on Windows App v26.8.5 and/or VS Code Extension v0.2.58. Both hosts share the same React webview for API / Runner / DB. Continue with the Starter Guide after install.

Windows installer (NSIS / Store)

  • Platform Availability: Windows Only
  • Overview: Install via SignOff-studio-Setup.exe (NSIS) or the Microsoft Store APPX build. Store is recommended when you want durable always-on monitors while the app stays installed and easy to update.
  • How It Works (Windows App):
    1. Download from qasignoff.com/download.
    2. Run SignOff-studio-Setup.exe (or install from Microsoft Store).
    3. Accept the license; choose install folder (default C:\Program Files\Signoff Studio).
    4. Optionally create a Desktop shortcut → Install → Finish (app launches).

Windows welcome after install

  • How It Works (VS Code Extension): N/A — use Marketplace / VSIX below.

VS Code activity bar

  • Code / Configuration Examples:
Requirements: Windows 10 or later
Default install: C:\Program Files\Signoff Studio
Workspaces:     %USERPROFILE%\Documents\Signoff Studio\
  • Edge Cases, Troubleshooting & Pro-Tips:
    • Uninstall keeps Documents\Signoff Studio\ workspaces.
    • Corporate lockdown: prefer per-user install when Program Files is blocked.
    • After upgrade, confirm Help → About shows 26.8.5 (or newer).

GAP IDENTIFIED: Windows installers are not available inside VS Code. Extension users still benefit from installing the Windows app for Git workbench and always-on monitors.

VS Code Marketplace / VSIX

  • Platform Availability: VS Code Only
  • Overview: Install Signoff Studio (qasignoff.qasignoff-vscode-extension) from Marketplace for auto-updates, or sideload a .vsix for QA builds (sideloaded builds do not auto-update).
  • How It Works (Windows App): N/A for extension packaging — optional companion install.

Windows about

  • How It Works (VS Code Extension):
    1. Extensions view → search Signoff Studio → Install (or code --install-extension path\to\signoff.vsix).
    2. Open the Signoff Studio Activity Bar icon.
    3. Click Open Signoff Studio or Command Palette → Signoff Studio: Open.

VS Code sidebar welcome

VS Code command palette

  • Code / Configuration Examples:
code --install-extension qasignoff.qasignoff-vscode-extension
code --list-extensions --show-versions | findstr qasignoff
  • Edge Cases, Troubleshooting & Pro-Tips:
    • No contributes.configuration and no contributed keybindings — configure inside the webview.
    • If the webview is blank after update: Developer: Reload Window.
    • Confirm extension version 0.2.58 (or newer) via Extensions detail.

GAP IDENTIFIED: VS Code has no native Git tab and monitors only fire while the panel is open. Install the Windows Store app when you need those capabilities.

Welcome & first workspace

  • Platform Availability: Full Parity (Welcome UI). Default paths Partial.
  • Overview: First launch offers Import Existing Project or Create Collection. Dismiss with X and return via Import or + New collection. Prefer importing the Starter Guide collection + httpbingo env.
  • How It Works (Windows App):
    1. Launch the app → Welcome.
    2. Import signoff-studio-starter.signoff.json + env, or create a blank collection.
    3. Workspaces default under Documents\Signoff Studio\.

Windows welcome

  • How It Works (VS Code Extension):
    1. Open Signoff Studio from Activity Bar / command.
    2. Same Welcome choices inside the editor webview.
    3. Pick or create a workspace folder (path may differ from Documents default).

VS Code sidebar welcome

  • Code / Configuration Examples:

Starter downloads (see Quick Start):

  • Edge Cases, Troubleshooting & Pro-Tips:
    • Closing Welcome does not delete data.
    • Use workspace menu / qasignoff.manageWorkspaces to juggle multiple roots.

Modes after install

  • Platform Availability: API / Runner / DB Full Parity; Git Windows Only
  • Overview: Top bar switches product modes. Schedulers only run while the UI is open.
  • How It Works (Windows App): Use API, Runner, DB, Git.

Windows API main

  • How It Works (VS Code Extension): Use API, Runner, DB only.

VS Code API main

  • Code / Configuration Examples:
Mode For
API Build and send requests
Runner Collection runs, load, monitors
DB SQL workbench
Git Windows-only workbench

GAP IDENTIFIED: Git mode is Windows Only.

Next

  1. Quick Start — import Starter Guide and complete core workflows
  2. Interface tour
  3. Settings · Shortcuts