Browse and download technical and functional baseline documentation from your AppIQ workspaces — directly inside VS Code.
Features
Workspace Browser — Tree view in the Activity Bar lists all your accessible AppIQ workspaces, organized by documentation type (Technical Baseline / Functional Specification / Source Bundles) and domain.
Single Document Download — Click the download icon on any document to save it locally.
Bulk Download — Download all documents under a workspace, documentation type, or domain in one click. Up to 4 documents download in parallel for speed.
In-Editor Preview — Click any document to preview its content directly in a VS Code tab.
Source Bundles — Browse and view bundled source code files associated with workspaces.
Shared Workspaces — Workspaces shared with you appear alongside your own.
Multi-Organization Support — Switch between organizations from the toolbar if you belong to more than one.
Browser Sign-In — Sign in securely with your AppIQ account via browser-based OAuth. Tokens are stored in your OS keychain.
Proxy Support — Works behind corporate proxies via VS Code's http.proxy setting or standard environment variables.
Status Bar — See your signed-in email and active organization at a glance.
Requirements
VS Code 1.85 or later
AppIQ account — The same account you use for the AppIQ web portal
Network access — HTTPS connectivity to your AppIQ instance
Getting Started
Install the extension and open VS Code.
Open Settings (Ctrl+,) and search for appiq. Set AppIQ URL to your organization's AppIQ address.
Click the AppIQ icon in the Activity Bar (left sidebar).
Click Sign In to AppIQ — your browser opens the sign-in page. After signing in, allow the browser to redirect back to VS Code.
If you belong to multiple organizations, pick one from the prompt. You can switch organizations anytime from the toolbar.
Your workspaces appear in the sidebar — expand to browse and download documentation.
Settings
Setting
Description
AppIQ URL
Your AppIQ address. Required — the extension does not work until this is set.
Download Path
Default folder for downloaded documentation. If not set, you'll be prompted each time.
Request Timeout
Timeout for API requests (default 30 seconds). Increase for large downloads on slow networks.
Troubleshooting
Problem
Solution
Sign-in does not return to VS Code
Allow the browser prompt to open VS Code when redirected.
Session expired
Refresh tokens expire after several days — simply sign in again.
Empty workspace list
Only workspaces with status Ready in the selected organization are shown.
Timeout errors
Increase the request timeout in settings.
Proxy issues
Set http.proxy in VS Code settings or configure the HTTPS_PROXY environment variable.
For detailed logs, open the Output panel (View > Output) and select AppIQ from the dropdown.
