Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tinkerer9/CollaboKeys/llms.txt

Use this file to discover all available pages before exploring further.

CollaboKeys supports a set of commands that can be entered either directly in the terminal on the host machine or through the admin panel’s custom command box. Both surfaces use the exact same command parser, so any command that works in the terminal works identically in the browser-based admin panel.
Terminal input is only active when console.enabled is set to true in src/config.json (default: true). The admin panel command box is available whenever the admin page is enabled, regardless of this setting.

​
Command Parsing

Commands are split into tokens by whitespace. Quoted strings — either single quotes ('...') or double quotes ("...") — are treated as a single token, which is useful for key names or text that contains spaces. 
press 'space'        # passes 'space' as one token
echo "hello world"   # passes 'hello world' as one token
The first token is the command name; all subsequent tokens are passed as arguments to that command.

​
Command Reference

​
stop

Aliases: exit, quit Terminates the CollaboKeys process. All player connections are dropped immediately. 
stop

​
echo

Prints all provided arguments back as output, joined by spaces — similar to the Unix echo command. Useful for testing the command pipeline. 
echo hello world
# → hello world
​
text
string
required
One or more words to echo back. Quoted strings are treated as a single token.

​
uri

Aliases: ip Prints the full server URL — the host machine’s local IP address combined with the active port. Share this URL with players so they can connect. 
uri
# → http://192.168.1.42:3000

​
enable

Aliases: e Enables either key emulation or automatic key reservation. 
enable <emulation|reservation>
​
type
string
required
What to enable. Accepted values:
  • emulation (alias: e) — allows keypresses to be forwarded to the active application
  • reservation (alias: r) — allows players to claim unassigned keys on first press
Examples: 
enable emulation
enable e          # same as above (alias)
enable reservation
enable r          # same as above (alias)

​
disable

Aliases: d Disables either key emulation or automatic key reservation. 
disable <emulation|reservation>
​
type
string
required
What to disable. Accepted values:
  • emulation (alias: e) — stops all keypresses from reaching the active application
  • reservation (alias: r) — prevents players from claiming new keys (existing assignments remain)
Examples: 
disable emulation
d e               # same as above using command alias + arg alias
disable reservation
d r               # same as above using command alias + arg alias

​
press

Aliases: type Manually emulates a key event on the host system, bypassing player assignment checks. Useful for testing key support or triggering a keypress without a connected player. 
press <key> [press|down|up]
​
key
string
required
The key name to emulate. Must be a valid key from the keycodes table (see keycodes command). Use quotes for keys with spaces, e.g. 'caps lock'.
​
type
string
The type of key event. Defaults to press if omitted.
  • press — a full key press and release
  • down — key held down
  • up — key released
Examples: 
press a
press space press
press 'caps lock' down
press return up

​
list

Aliases: ls Lists all connected players or a filtered subset. For each player, the output includes their name (or player number if unnamed), internal ID, IP address, and currently assigned keys. 
list <all|active|wr|nameless>
​
filter
string
Which players to show. Defaults to all if omitted.
  • all — every connected client
  • active — players with a name set who are not in the waiting room
  • wr — players currently in the waiting room (also accepts waitingroom)
  • nameless — players who haven’t entered a username yet
Examples: 
list
list all
list active
list wr
ls nameless

​
waitingroom

Aliases: wr Admits or dismisses a player (or all players) from the waiting room. 
waitingroom <admit|dismiss> <id|all>
​
action
string
required
The action to perform:
  • admit (alias: a) — moves the player out of the waiting room so they can press keys
  • dismiss (alias: d) — sends the player back to the waiting room, blocking their input
​
target
string
required
  • A numeric player ID (visible from list wr)
  • all — applies the action to every connected player
Examples: 
waitingroom admit 3
waitingroom dismiss all
wr a 3             # admit player #3 using aliases
wr d all           # dismiss all players using aliases

​
key

Aliases: k Modifies a key’s assignment or enabled status. 
key <assign|revoke|enable|disable> <keyname|all>
​
action
string
required
The action to perform:
  • assign (alias: a) — looks up the key’s current state and prints guidance. If the key is already reserved, the server suggests using key revoke first; otherwise it instructs you to ask the player to press the key once so it auto-reserves to them. Note: direct assignment via this command is not supported — keys are claimed by players pressing them (auto-reservation).
  • revoke (alias: r) — clears the key’s player assignment so anyone can claim it again
  • enable (alias: e) — marks the key as available for emulation
  • disable (alias: d) — blocks emulation for this key even if a player has it assigned
​
target
string
required
  • A valid key name (e.g. a, space, return, 'caps lock')
  • all — applies the action to every key in the keycodes table (not meaningful for assign)
Examples: 
key assign a       # prints guidance for getting player to claim 'a'
key revoke a
key revoke all
key enable space
key enable all
key disable 'caps lock'
k d all            # disable all keys using aliases

​
keycodes

Aliases: kc Prints a table of all keys in the keycodes list, including their keycode, human-readable name, current enabled/disabled status, and assigned player ID. 
keycodes
When run from the admin panel, this command does not print the table in the Responses panel. Instead, it opens the /keycodes page in a new browser tab, which displays the same information in a formatted layout.

​
logs

Aliases: l Shows the file path and URL for a log file. 
logs [combined|error|warn]
​
type
string
Which log file to reference. Defaults to combined if omitted.
  • combined — all log levels (error, warn, info, http)
  • error — error-level logs only
  • warn — warning-level logs only
Examples: 
logs
logs combined
logs error
logs warn
l warn
When run from the admin panel, logs and its variants open the corresponding log page (/logs, /logs/error, /logs/warn) in a new browser tab rather than printing to the Responses panel.

​
Quick Reference Table

CommandAliasesArgumentsDescription
stopexit, quit—Terminate the process
echo—<text...>Echo input back as output
uriip—Print server URL
enablee<emulation|reservation>Enable emulation or auto-reservation
disabled<emulation|reservation>Disable emulation or auto-reservation
presstype<key> [press|down|up]Manually emulate a key event
listls[all|active|wr|nameless]List players
waitingroomwr<admit|dismiss> <id|all>Admit or dismiss players
keyk<assign|revoke|enable|disable> <keyname|all>Manage key assignment or enabled status
keycodeskc—Show keycodes table
logsl[combined|error|warn]Show log file path and URL

Build docs developers (and LLMs) love

Get started for freeTalk to us