Registry / communication / thinkncollab-shell

thinkncollab-shell

library0.0.12jsnpmunverified

A real-time collaborative terminal shell (thinknsh) that integrates with the ThinkNCollab platform via WebSocket. Version 0.0.12, pre-1.0 beta. Allows users to join collaboration rooms, chat, manage tasks, share terminals, and receive live notifications — all from the CLI. Key differentiators: built for real-time team collaboration directly in the terminal, with persistent sessions, HMAC-SHA256 token auth, and a .tncproject auto-boot feature. Release cadence is irregular as the package is early-stage.

communication devops

npm install thinkncollab-shell

package ↗

INSTALL

IMPORT

SIG · THINKNCOLLAB-SHELL

thinkncollab-shell

communicationjavascriptv0.0.12

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.

shell

✓ import shell from 'thinkncollab-shell'

✗ const shell = require('thinkncollab-shell')

Package is ESM-only; CommonJS require will fail.

createShell

✓ import { createShell } from 'thinkncollab-shell'

Named export for programmatic usage.

ShellOptions

✓ import type { ShellOptions } from 'thinkncollab-shell'

TypeScript types available for shell configuration.

Shows how to programmatically create and start a ThinkNCollab shell session, then execute commands.

import { createShell } from 'thinkncollab-shell'; const shell = createShell({ server: process.env.THINKNCOLLAB_SERVER ?? 'https://thinkncollab.com', apiUrl: process.env.THINKNCOLLAB_API_URL ?? 'https://thinkncollab.com', wsUrl: process.env.THINKNCOLLAB_WS_URL ?? 'https://thinkncollab.com', autoConnect: process.env.THINKNCOLLAB_AUTO_CONNECT === 'true', }); shell.start().then(() => { shell.runCommand('login'); shell.runCommand('join room-123'); shell.runCommand('say Hello team!'); });

Debug

Known issues

breakingThe package is pre-1.0 and may have breaking changes without major version bumps.

fix

Pin to a specific version and review changelog before upgrading.

affects: <1.0

gotchaWebSocket connections may fail if environment variables are not set correctly; defaults assume thinkncollab.com.

fix

Set THINKNCOLLAB_SERVER, THINKNCOLLAB_API_URL, and THINKNCOLLAB_WS_URL to your server.

affects: >=0.0.1

deprecatedThe global binary 'thinknsh' is the recommended interface; programmatic API may change.

fix

Use the CLI binary instead of importing for stability.

affects: >=0.0.1

Errors

Common errors & fixes

Error: listen EADDRINUSE :::<port>

Notification window TCP port conflict

fix

Set THINKNSH_NOTIFY_PORT to an available port or restart with a different port.

TypeError: shell.start is not a function

Using CommonJS require() instead of ESM import

fix

Change to ESM import: import { createShell } from 'thinkncollab-shell'

WebSocket connection closed with code 1006

Authentication token expired or invalid

fix

Re-run the 'login' command to refresh your session token.

Upgrade

Version history

0.0.12latest on npm

Audit

Dependencies

websocketrequiredWebSocket client for real-time communication

commanderrequiredCommand-line interface framework

inquirerrequiredInteractive prompts in the shell

Agent activity

17 hits · last 30 days

node

OpenAI (training)

Resources

packagethinkncollab-shell ↗