Repository files navigation

Terminal client for cabal, the p2p chat platform.

Seecabal-core for the underlyingdatabase & api.

chat with us:npx cabal cabal://cabal.chat

$ npm install --global cabal$ cabal --new

If that fails the newest node is not yet supported by the stack. Try this:

Installnvm, open a new shell and run

$ nvm install 12$ npm install --global cabal$ cabal --new

cabal --new

then copy the key and give it to someone else.

cabal <key>

e.g.

cabal cabal://0201400f1aa2e3076a3f17f4521b2cc41e258c446cdaa44742afe6e1b9fd5f82

save a cabal to the config

cabal --save <key>

then connect to all of your saved cabals, by simply runningcabal:

cabal

show saved cabals with--cabals and remove a saved cabal with--forget

cabal --cabalscabal --forget <key|alias>

create a local name for a key.

cabal --alias <name> --key <key>cabal <name>

Cabal can use a webcam connected to your computer to read a cabal key from a QR code.For this to work, you'll need to install an additional system dependency:

• Linux:sudo apt-get install fswebcam
• MacOS:brew install imagesnap

# Hold up your QR code in front of the webcam and then run:cabal --qr

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

cabal <key> --seed

If you have a tightly configured firewall and need to port-forward a port, the default port Cabal uses is port13331.You can change this with the--port flag, or settingpreferredPort in your .cabal.yml config file.

cabal <key> --seed --port 7331

/add,/cabaladdacabal/newcreateanewcabal/nick,/nchangeyourdisplayname/emote,/mewriteanold-schooltextemote/namesdisplaythenamesofthecurrentlyonlinepeers/channelsdisplaythecabal'schannels/panessetpanetonavigateupanddowninpanes:channels,cabals/join,/jjoinanewchannel/leave,/lleaveachannel/clearclearthecurrentbackscroll/helpdisplaythishelpmessage/qrgenerateaqrcodewiththecurrentcabal'saddress/quit,/exitexitthecabalprocess/topic,/motdsetthetopic/description/messageofthedayforachannel/whoami,/keydisplayyourlocaluserkey/whoisdisplaythepublickeysassociatedwiththepassedinnickalt-nmovebetweenchannels/cabalspanesctrl-{n,p}moveup/downchannels/cabals

ctrl-l
    redraw the screen
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
ctrl-a
    go to next unread channel
pageup
    scroll up through backlog
pagedown
    scroll down through backlog
shift-pageup
    scroll up through nicklist
shift-pagedown
    scroll down through nicklist
alt-[1,9]
    select channels 1-9
alt-n
    tab between the cabals & channels panes
alt-l
    tab toggle id suffixes on/off

The message styling can beslightly tweaked.
Regarding the supported options, see.cabal.yml-example