socket-cli

Terminal client for socket, the p2p chat platform.

See socket-core for the underlying database & api.

Installation

$ npm install --global socket
$ socket --key socket://0201400f1aa2e3076a3f17f4521b2cc41e258c446cdaa44742afe6e1b9fd5f82

Usage

Start a new instance:

socket --new

Connect to an existing instance:

socket --key <key>

e.g.

socket --key socket://0201400f1aa2e3076a3f17f4521b2cc41e258c446cdaa44742afe6e1b9fd5f82

Headless mode

This will run socket without a UI. You can use this to seed a socket (e.g. on a VPS) and make its data more available:

socket --key <key> --seed

Commands

/add, /socket
  add a socket
/new
  create a new socket
/nick, /n
  change your display name
/emote, /me
  write an old-school text emote
/names
  display the names of the currently online peers
/channels
  display the socket's channels
/panes
  set pane to navigate up and down in panes: channels, sockets
/join, /j
  join a new channel
/leave, /l
  leave a channel
/clear
  clear the current backscroll
/help
  display this help message
/quit, /exit
  exit the socket process
/topic, /motd
  set the topic/description/message of the day for a channel
/whoami, /key
  display your local user key
/whois
  display the public keys associated with the passed in nick

alt-n
  move between channels/sockets panes
ctrl+{n,p}
  move up/down channels/sockets

Hotkeys

ctrl+u
    clear input line
ctrl+w
    delete last word in input
up-arrow
    cycle through command history
down-arrow
    cycle through command history
home
    go to start of input line
end
    go to end of input line
ctrl+n
    go to next channel
ctrl+p
    go to previous channel
pageup
    scroll up through backlog
pagedown
    scroll down through backlog
alt-[1,9]
    select channels 1-9
alt-n
    tab between the sockets & channels panes