jamesg-trading-cli v1.0.1
jamesg-trading-cli
JamesG Trading is a platform developed by James Gallagher that facilitates and processes investments in him, as a publicly traded person. This repository contains the code for the Command Line Interface for JamesG users.
If you are interested in the accompanying API, you can view it here. You can also view the Client for the JamesG Trading platform here.
Get an API Key
Before you get started with this CLI, you will need to obtain an API key from the client.
To do so, go to the settings page on your JamesG Trading instance. The official settings page is at https://www.jamesg.app/settings.
Your API key will be at the bottom of that page in the section labeled "API Key".
Usage
$ npm install -g jamesg-trading-cli
$ jamesg COMMAND
running command...
$ jamesg (-v|--version|version)
jamesg-trading-cli/1.0.0 darwin-x64 node-v11.9.0
$ jamesg --help [COMMAND]
USAGE
$ jamesg COMMAND
...Commands
jamesg auth:infojamesg auth:loginjamesg auth:logoutjamesg auth:tokenjamesg auth:whoamijamesg help [COMMAND]jamesg leaderboardjamesg pricejamesg questions:commentsjamesg questions:getjamesg questions:votesjamesg trades:getjamesg trades:placejamesg updatesjamesg users
jamesg auth:info
display user account information
USAGE
$ jamesg auth:info
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/auth/info.js
jamesg auth:login
login to your jamesg account
USAGE
$ jamesg auth:login
OPTIONS
-k, --api_key=api_key API Key
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/auth/login.js
jamesg auth:logout
logout of your jamesg account
USAGE
$ jamesg auth:logout
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/auth/logout.js
jamesg auth:token
Describe the command here
USAGE
$ jamesg auth:token
OPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/auth/token.js
jamesg auth:whoami
display the current logged in user
USAGE
$ jamesg auth:whoami
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/auth/whoami.js
jamesg help [COMMAND]
display help for jamesg
USAGE
$ jamesg help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLISee code: @oclif/plugin-help
jamesg leaderboard
list jamesg users
USAGE
$ jamesg leaderboard
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/leaderboard.js
jamesg price
get current share price
USAGE
$ jamesg price
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/price.js
jamesg questions:comments
list question comments
USAGE
$ jamesg questions:comments
OPTIONS
-q, --question=question Question id
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/questions/comments.js
jamesg questions:get
list user questions
USAGE
$ jamesg questions:get
OPTIONS
-a, --approved=approved Question approved (true, false)
-q, --question=question Question id
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/questions/get.js
jamesg questions:votes
list question votes
USAGE
$ jamesg questions:votes
OPTIONS
-q, --question=question Question id
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/questions/votes.js
jamesg trades:get
list user trades
USAGE
$ jamesg trades:get
OPTIONS
-u, --user=user User name
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/trades/get.js
jamesg trades:place
place trade of shares
USAGE
$ jamesg trades:place
OPTIONS
-s, --shares=shares Amount of shares
-t, --order_type=order_type Order type (buy, sell)
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/trades/place.js
jamesg updates
list shareholder updates
USAGE
$ jamesg updates
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/updates.js
jamesg users
list jamesg users
USAGE
$ jamesg users
OPTIONS
-u, --user=user User id
DESCRIPTION
...
Extra documentation goes hereSee code: src/commands/users.js