status-im
/
status-x
mirror of https://github.com/status-im/status-x.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Status Command Line Chat Client (WIP)
24 Commits 4 Branches 0 Tags 142 KiB
TypeScript 95.4%
JavaScript 4.6%
Go to file
Iuri Matias 04f16d71fa
Merge pull request #2 from status-im/pipeline 
add dev pipeline; babel; linter; typescript support; readme
 		2018-12-03 20:04:55 -05:00
src add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
.eslintrc.json add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
.gitignore add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
README.md update readme 2018-12-03 20:04:36 -05:00
babel.config.js add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
package-lock.json throttle typing notifications; improve somewhat the typing status; ignore typing notifications from self 2018-11-08 19:06:31 -05:00
package.json add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
tsconfig.json add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
tslint.json add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00
yarn.lock add dev pipeline; babel; linter; typescript support; readme 2018-12-03 20:02:24 -05:00

README.md

status-x

Command line chat client for status

WIP. DO NOT USE IN PRODUCTION. HIGH RISK ⚠


Install

clone the repo via git:

$ git clone https://github.com/status-im/status-x.git

And then install the dependencies with yarn.

$ cd status-x
$ yarn

To develop:

$ yarn run start
$ yarn run lint

To run:

node dist/index.js

status-x requires geth or murmur to be able to connect to Whisper. If using geth, you may start it with the following flags.

geth --testnet --syncmode=light --ws --wsport=8546 --wsaddr=localhost --wsorigins=statusjs --rpc --maxpeers=25 --shh --shh.pow=0.002 --wsapi=eth,web3,net,shh,debug,admin

Also, due to the lack of nodes with Whisper enabled, you need to create a static-nodes.json file, that must be placed in a specific path (if using testnet and Linux, ~/.ethereum/testnet/geth/static-nodes.json

Commands

TODO

  • /join #channelName - join a channel
  • /s 1 - switch to channel or chat indexed 1
  • /msg 0xpubkey - start a chat with user given his pubkey

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to status-js, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on #status-js channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.