thinkncollab-shell Documentation

// 01

Installation

Install thinkncollab-shell globally via npm. Requires Node.js 16.0 or higher.

Prerequisites: Node.js ≥16.0, npm, and a ThinkNCollab account.

Install globally

bash

npm install -g thinkncollab-shell

Verify installation

bash

thinknsh --version
# thinkncollab-shell v0.0.5

Update to latest

bash

npm update -g thinkncollab-shell

Launch ThinkNCollab-Shell

bash

thinknsh

// 02

Authentication

Authenticate once and your credentials are stored securely in a .tncrc file in your home directory.

Login

bash

 login
# Prompts for email + password
# Stores encrypted token in ~/.tncrc

Check current user

bash

 whoami
# → logged in as: [email protected]

Logout

bash

 logout

Security: Never share your .tncrc file or commit it to version control. Regenerate your token via thinkncollab-shell token:refresh if compromised.

// 03

Quick Start

Up and running in under a minute.

Quick setup: Install → Login → Join a room → Push files

bash

# 1. Install
npm install -g thinkncollab-shell

# 2. Authenticate
 login

# 3. List your rooms
 rooms

# 4. Join a room
 rooms join <room-id>

# 5. Push a file to the room
 push ./myfile.js --room <room-id>

# 6. Check notifications
 notifications

// 04

Rooms

List, join, create, and manage collaboration rooms directly from the terminal.

rooms

List all rooms you're a member of

rooms join

Join an existing room by ID

rooms create

Create a new collaboration room

rooms info

View details of a specific room

Command	Description
rooms	List all rooms you belong to
rooms join <id>	Join a room by its ID
rooms create <name>	Create a new room
rooms info <id>	View room details and members
rooms leave <id>	Leave a room
rooms members <id>	List members in a room

Examples

bash

 rooms
# → room-01  backend-team     (12 members)
# → room-02  frontend-sprint  (7 members)

 rooms join room-01
# ✓ joined backend-team

 rooms create "design-review"
# ✓ created room: design-review (id: room-09)

// 05

Files & Push

Push files to rooms, view version history, and pull updates — similar to Git but built into ThinkNCollab's collaboration layer.

Command	Options	Description
push <file>	--room <id>	Push a file to a room
push <dir>	--room <id> --all	Push entire directory
pull <file>	--room <id>	Pull latest version from room
files	--room <id>	List files in a room
files history <file>	--room <id>	View version history of a file
files diff <file>	--v1 --v2	Diff two versions of a file

bash

# Push a single file
 push ./src/index.js --room room-01
# ✓ pushed index.js → backend-team (v4)

# Push all files in a directory
 push ./src --room room-01 --all
# ✓ pushed 6 files → backend-team

# View version history
 files history index.js --room room-01
# v1  2025-10-01  [email protected]
# v2  2025-10-04  [email protected]
# v3  2025-10-07  [email protected]

Authentication is verified via your .tncrc token on every push. Ensure you're logged in before pushing files.

// 06

Notifications

View, watch, and manage your ThinkNCollab notifications from the terminal. The notification window opens as a separate terminal panel.

Command	Description
notifications	List all unread notifications
notifications --all	Show all notifications (read + unread)
notifications watch	Open live notification panel (manual)
notifications mark-read	Mark all notifications as read
notifications mark-read <id>	Mark a single notification as read
notifications clear	Clear all read notifications

bash

 notifications
# [unread] omkar pushed routes.js to backend-team
# [unread] radhika commented on your file
# [read]   meeting scheduled: tomorrow 10am

# Open live notification panel (you open manually)
 notifications watch
# → Watching for new notifications... (Ctrl+C to exit)

The notification panel does not auto-launch on shell start. Open it manually when you need it with notifications watch.

// 07

Workspace

Switch between workspaces, view team members, and manage workspace settings.

Command	Description
workspace	Show current active workspace
workspace list	List all workspaces you belong to
workspace switch <id>	Switch active workspace
workspace members	List all members in current workspace
workspace invite <email>	Invite a user to the workspace

// 08

Tasks // coming soon

Task management commands are planned for an upcoming release of . They already exist in the thinkncollab-cli (tnc-cli) package if you need them now.

Coming soon in : tasks, task add, task done. Available today via tnc-cli.

Command	Status	Description
tasks	coming soon	List all tasks in current workspace
task add <title>	coming soon	Create a new task
task done <id>	coming soon	Mark a task as complete
task assign <id>	coming soon	Assign a task to a team member

// 09

Config

View and manage your local configuration stored in ~/.tncrc.

Command	Description
config	Show current config
config set <key> <value>	Set a config value
config reset	Reset all config to defaults
token:refresh	Refresh your auth token
token:revoke	Revoke and delete your token

// 10

Advanced Usage

Power-user patterns, scripting, and CI integration.

CI / non-interactive login

bash

# Use env variables for CI pipelines
TNC_EMAIL[email protected] TNC_TOKEN=your_token  login --ci
 push ./dist --room room-01 --all

npm scripts integration

json

// package.json
{
  "scripts": {
    "push:dev": " push ./src --room room-01 --all",
    "push:prod": " push ./dist --room room-02 --all",
    "notifs": " notifications watch"
  }
}

Debug mode

bash

 --debug rooms
 system:info

// 11

Troubleshooting

Common issues and fixes

Clear cache

bash

 cache:clear

Auth token expired

bash

 token:refresh
# or logout and back in
 logout &&  login

System info

bash

 system:info
 diagnose

// 12

FAQ

What's the difference between thinkncollab-shell and tnc-cli?

is the interactive shell CLI — rooms, push, notifications, workspace. tnc-cli (thinkncollab-cli) is the version-control-focused CLI with task management already built in.

Where is the .tncrc file stored?

It's stored in your user home directory: ~/.tncrc. Never commit this file to version control — it contains your encrypted auth token.

How do I use thinkncollab-shell in a CI/CD pipeline?

Use environment variables: TNC_EMAIL and TNC_TOKEN, then run login --ci for non-interactive authentication.

Does the notification window auto-launch?

No — you open it manually when you need it with thinkncollab-shell notifications watch. This is by design so it doesn't interfere with your shell session.

Where are local logs stored?

Local logs are in ~/.thinkncollab/logs/. View them with thinkncollab-shell logs or open the file directly.

// 13

Get Help

Multiple ways to reach us or find answers.

// docs

Full API reference and guides

Read docs

// github

Report issues and contribute

View repo

// discord

Join our developer community

Join server

// email

Reach the team directly

Send email

Built-in support command

bash

 support:contact
# Or email: [email protected]