Skip to content

ibm-messaging/mq-console-vscode-extension

Repository files navigation

IBM MQ Console Extension

This tool provides an easy way to quickly access your IBM MQ Console within Visual Studio Code's built-in integrated browser. With this tooling, users can easily switch through different screens in their Visual Studio Code environment to administer MQ objects in the IDE.

Features

  • Quick Access: Open your IBM MQ Console with a single command or status bar click
  • Browser Integration: View IBM MQ Console in VS Code's integrated browser without leaving your editor

Installation from VSIX file

  • Download mq-console-extension-1.0.0.vsix from the repo.
  • Open VS Code
  • Go to Extensions view (Ctrl+Shift+X / Cmd+Shift+X)
  • Click the "..." menu at the top
  • Select "Install from VSIX..."
  • Choose the mq-console-extension-1.0.0.vsix file

For detailed installation instructions see: INSTALLATION.md

Usage

Setting the IBM MQ Console URL

  1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Type "IBM MQ Console: Set Console URL"
  3. Enter your IBM MQ Console URL (e.g., https://localhost:9443/ibmmq/console)
  4. Press Enter to save

Opening the IBM MQ Console

Method 1: Command Palette

  1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Type "IBM MQ Console: Open Console"
  3. Press Enter
  4. The IBM MQ Console will open in VS Code's integrated browser

Method 2: Status Bar

  • Click the "IBM MQ Console" button in the status bar (bottom right)
  • The console opens in VS Code's integrated browser tab

Using the Integrated Browser:

  • The IBM MQ Console opens in a browser tab within VS Code
  • You can use the browser's built-in navigation and refresh controls
  • The tab can be moved, split, or closed like any VS Code editor tab
  • Your configured URL is remembered for quick access

Clearing the Saved URL

  1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Type "IBM MQ Console: Clear Console URL"
  3. Confirm the action

Configuration

The extension provides the following settings:

MQConsole.URL

  • Type: string
  • Default: ""
  • Description: URL of the IBM MQ Console
  • The URL must start with http:// or https://

You can modify this setting in:

  • Settings UI: File > Preferences > Settings (search for "MQ Console")
  • settings.json: Add the following:
    {
      "MQConsole.URL": "https://localhost:9443/ibmmq/console"
    }

Commands

The extension contributes the following commands:

Command Description
IBM MQ Console: Set Console URL Configure the MQ Console URL
IBM MQ Console: Open Console Open the configured MQ Console
IBM MQ Console: Clear Console URL Clear the saved MQ Console URL

Requirements

Known Issues

You may have to adjust the color scheme in your settings if you're experiencing any quirks with the UI of the console. In visual studio code, navigate to Settings, search for Workbench: Color Theme, and try an alternative color scheme to solve any UI abnormalities.

Please report issues on the project repository.

Release Notes

1.0.0

Initial release of IBM MQ Console Extension:

  • Configure and save IBM MQ Console URL
  • Quick access via command palette or status bar
  • Opens IBM MQ Console in VS Code's integrated browser
  • Persistent URL storage across sessions

Development

Building from Source

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Watch for changes
npm run watch

# Package extension
npm run package

Project Structure

mq-console-extension/
├── src/
│   └── extension.ts       # Main extension code
├── out/                   # Compiled JavaScript (generated)
├── package.json           # Extension manifest
├── tsconfig.json          # TypeScript configuration
└── README.md             # This file

Issues and contributions

For issues relating specifically to this connector, please use the GitHub issue tracker. If you do want to submit a Pull Request related to this connector, please read the contributing guide first to understand how to sign your commits.

License

Copyright 2026 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.The project is licensed under the Apache 2 license.


About

Connect to IBM MQ Console via VS Code integrated browser

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors