tabby-ws-term

library0.2.2jsnpmunverified

Tabby plugin that enables WebSocket terminal connections, primarily designed for Kubernetes web terminals (e.g., k8s exec). It allows Tabby to connect to WebSocket-based terminal services directly. Current version 0.2.2 is stable but early-stage, with no recent updates. It requires Tabby nightly builds (>=1.0.231-nightly.0) and Angular 15. Differentiates as a lightweight, focused solution for K8s terminal access within Tabby, unlike generic web terminals.

devops

npm install tabby-ws-term

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TABBY-WS-TERM

tabby-ws-term

devopsjavascriptv0.2.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

TabbyWsTermPluginModule

✓ import { TabbyWsTermPluginModule } from 'tabby-ws-term'

✗ import { TabbyWsTermPluginModule } from 'tabby-ws-term/tabby-ws-term'

Module is exported from the package root; ensure Angular module is imported in your app module.

TabbyWsTermPluginModule forRoot

✓ import { TabbyWsTermPluginModule } from 'tabby-ws-term'; ... imports: [TabbyWsTermPluginModule.forRoot()]

✗ import { TabbyWsTermPluginModule } from 'tabby-ws-term/forRoot'

Use .forRoot() to configure; do not import from subpath.

WSTermProfileProvider

✓ import { WSTermProfileProvider } from 'tabby-ws-term'

✗ import { WsTermProfileProvider } from 'tabby-ws-term'

Symbol is case-sensitive; provider is used in Tabby's profile system.

Shows Angular module registration for the Tabby WS terminal plugin and basic profile configuration.

// In Tabby plugin development, register the plugin module. import { NgModule } from '@angular/core'; import { TabbyWsTermPluginModule } from 'tabby-ws-term'; @NgModule({ imports: [ TabbyWsTermPluginModule.forRoot() ] }) export class AppModule { } // Then configure a WebSocket terminal profile in Tabby settings: // { "type": "ws-term", "name": "K8s Shell", "url": "ws://your-k8s-api/exec/..." }

Debug

Known issues

breakingRequires tabby-core, tabby-settings, tabby-terminal nightly builds (>=1.0.231-nightly.0). If you use stable Tabby, this plugin will not load.

fix

Use Tabby nightly builds or ensure matching version.

affects: >=0.1.0

deprecatedThis plugin has not been updated for Angular 16+; peer dependencies specify Angular 15.

fix

Pin to Angular 15 or wait for update.

affects: >=0.1.0

gotchaWebSocket URL must be reachable from the Tabby process; CORS and mixed content issues may arise.

fix

Ensure WebSocket server supports same-origin or configure properly.

affects: >=0.1.0

gotchaProfile type string is 'ws-term' (lowercase), not 'websocket-term'.

fix

Use type: 'ws-term' in profile JSON.

affects: >=0.1.0

deprecatedAngular 15 is nearing end of life; upgrade path unclear.

fix

Monitor repository for updates.

affects: >=0.2.0

Errors

Common errors & fixes

Error: Could not find module 'tabby-ws-term'

Package not installed or npm links broken.

fix

Run 'npm install tabby-ws-term' and ensure it's in node_modules.

ERROR in ./node_modules/tabby-ws-term/... Module not found: Error: Can't resolve 'tabby-core'

Missing peer dependency tabby-core.

fix

Install tabby-core (nightly) with 'npm install tabby-core@1.0.231-nightly.0'.

Angular compiler: '<path>' is not part of the compilation output.

Plugin module not correctly imported in Angular app.

fix

Ensure TabbyWsTermPluginModule.forRoot() is added to your app's @NgModule imports.

TypeError: Cannot read properties of undefined (reading 'open')

WebSocket URL is invalid or not provided in profile.

fix

Check profile JSON has a valid 'url' field with ws:// or wss:// scheme.

Upgrade

Version history

0.2.2latest on npm

Audit

Dependencies

tabby-corerequiredCore Tabby extension API

tabby-settingsrequiredPlugin settings integration

tabby-terminalrequiredTerminal UI component

@angular/corerequiredAngular framework runtime

rxjsrequiredReactive extensions for async operations

Agent activity

6 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/ruanimal/tabby-ws-term ↗

packagetabby-ws-term ↗

homepagehttps://github.com/ruanimal/tabby-ws-term#readme ↗