Repository files navigation

Before installation, make sure all dependencies are installed:

• curl
• json-c
• ncurses
• gtk3
• cairo
• libglade

$ git clone https://github.com/aokellermann/tick.git&&cd tick$ sudo make install

If you are an Arch user, you can install from the AUR.

$ aurman -S tick

The GTK+ window can be opened by simply running the command "tick".Currently, it only supports portfolio operations. If you would like touse the CLI, additional arguments must be used.

To update your portfolio, use the options add, rm, or set. You may use thespecial string "USD$" to add US Dollars to your portfolio.

$ tick [add/rm/set] [symbol/crypto_id/USD$] [quantity of shares] [USD spent]

For example, to add 3 shares of Tesla bought for $918.12 total, run

$ tick add tsla 3 918.12

You can also specify the price per share instead of total spent:

$ tick add tsla 3 306.04ea

The parameter "add" will add your input to the current portfolio, "rm" willsubtract from your current portfolio, and "set" will set your portfolio tothe input, discarding any existing data about that security. Trading costs/feesshould be factored into your USD spent. When adding a cryptocurrency to yourportfolio, you must use the cryptocurrency's name. For instance, to add Ripple,you must use "ripple" instead of "xrp". This is due to some cryptocurrencytickers also being listed on the stock market, such as ETH.

To get info about your current holdings, run

$ tick check

Prints information about all of your current holdings and a grand totalin an NCurses window. By default, your holdings will be sortedalphabetically. You may press the left and right arrow keys to changethe sort category, or up and down to highlight different securities.Press "q" to exit the window. You can also get information on a specificsecurity using

$ tick check [symbol/crypto_id/USD$]

You may encrypt your portfolio using the RC4 algorithm

$ tick encrypt

and decrypt it with

$ tick decrypt

You can modify and check your portfolio without explicitly decrypting it.

To get information about a security, you can use the info command.

$ tick info tsla

The graph command will print out a graph in your terminal of the historicprice of the given security. Cryptocurrencies aren't supported yet, due toAPI constraints. You may press the UP arrow key to zoom in, the DOWN arrowkey to zoom out, the LEFT arrow to pan left, the RIGHT arrow to pan right,or the letter "q" to quit.

$ tick graph [symbol]

The cmp command has the same functionality as graph, but is intended forcomparing two securities. The command takes two symbols as arguments.Both graphs will be displayed.

$ tick cmp [symbol] [symbol]

To compare the graphs of Tesla and Ford, run

$ tick cmp tsla f

To get news articles about a security you can use the news command. Thenumber of articles can be specified, but will default to three. You mayrequest a maximum of 50 articles.

$ tick news [symbol] [number of articles (optional)]

Once installed, you may read the man page for more information.

MIT License

Stock information is taken from IEX's free API. Mutual fund andover-the-counter information is taken from AlphaVantage's free API.Cryptocurrency information is taken from Coinmarketcap's free API.Please do not abuse the APIs by repeatedly requesting information. Readthe provided license for more information.

• APIv2 will be released in early Q4 (https://github.com/iexg/IEX-API/issues/403), which will likely enable:
  • Better reliability for issue type (I had problems in the past with it)
  • Mutual funds
  • Options
  • Commodities
  • Indices
  • OTC
  • Treasuries
  • Ratings
  • Currencies
  • International
• DEB/RPM package
• Bookmark certain stocks (not included in portfolio)
• Zoom in more than one month for ncurses graph
• Average graph points when skipping indices for greater accuracy
• Android app?
• Implement Coinmarketcap v2
• Notes for portfolio securities
• Mutex on portfolio
• Add security without reloading every security
• Refactoring
• gtk graph zoom
• enum sort option