Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericm/stonks
Stonks is a terminal based stock visualizer and tracker that displays realtime stocks in graph format in a terminal. See how fast your stonks will crash.
https://github.com/ericm/stonks
ascii-art aur cli curl go golang graphs hacktoberfest linux macos stock-cli stock-data stock-market stock-market-data stock-visualizer stocks terminal-based terminal-graphics tracker wtfutil
Last synced: about 2 months ago
JSON representation
Stonks is a terminal based stock visualizer and tracker that displays realtime stocks in graph format in a terminal. See how fast your stonks will crash.
- Host: GitHub
- URL: https://github.com/ericm/stonks
- Owner: ericm
- License: gpl-3.0
- Created: 2020-05-13T18:12:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T22:51:18.000Z (over 1 year ago)
- Last Synced: 2024-09-30T02:40:58.609Z (2 months ago)
- Topics: ascii-art, aur, cli, curl, go, golang, graphs, hacktoberfest, linux, macos, stock-cli, stock-data, stock-market, stock-market-data, stock-visualizer, stocks, terminal-based, terminal-graphics, tracker, wtfutil
- Language: Go
- Homepage: https://stonks.icu
- Size: 1.78 MB
- Stars: 544
- Watchers: 13
- Forks: 35
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - ericm/stonks - Stonks is a terminal based stock visualizer and tracker that displays realtime stocks in graph format in a terminal. See how fast your stonks will crash. (Go)
README
# 
[](https://github.com/ericm/stonks/blob/master/LICENSE)
[](https://github.com/ericm/stonks/graphs/contributors)
[](https://github.com/ericm/stonks/commits/master)
[](https://github.com/ericm/stonks/releases)
[](https://aur.archlinux.org/packages/stonks/)
Stonks is a terminal based stock visualizer and tracker.
## Installation
Requirements: golang >= 1.13
### Manual
1. Clone the repo
2. Run `make && make install`
### Packages
Stonks is available on:
- [The AUR](https://aur.archlinux.org/packages/stonks/). You can install it on arch linux with my other project [yup](https://github.com/ericm/yup): `$ yup -S stonks`
- HomeBrew: `brew install ericm/stonks/stonks`
### Binaries
Binaries are now available for Windows, MacOSX and Linux under each [release](https://github.com/ericm/stonks/releases)
## [Online installationless usage (via curl)](http://stonks.icu)
You can now access basic stock graphs for passed stock tickers via the stonks HTTPS client (https://stonks.icu).
Try it:
```
$ curl -L stonks.icu/amd/ba
```
## Usage
It uses Yahoo Finance as a backend so use the ticker format as seen on their website.
```
Displays realtime stocks in graph format in a terminal
Usage:
stonks [flags]
Flags:
-d, --days int 24 hour period of stocks from X of days ago.
-e, --extra Include extra pre + post time. (Only works for day)
-h, --help help for stonks
-i, --interval string stonks -i X[m|h] (eg 15m, 5m, 1h, 1d) (default "15m")
-n, --name string Optional name for a stonk save
-r, --remove string Remove an item from favourites
-s, --save string Add an item to the default stonks command. (Eg: -s AMD -n "Advanced Micro Devices")
-t, --theme string Display theme for the chart (Options: "line", "dot", "icon")
-v, --version stonks version
-w, --week Display the last week (will set interval to 1d)
-y, --year Display the last year (will set interval to 5d)
--ytd Display the year to date (will set interval to 5d)
```
### `$ stonks`
Gives graphs and current value/change of _saved_ stocks.
### `$ stonks -s AMD -n "Advanced Micro Devices"`
Add a favourite stock to be tracked with `$ stonks`
### `$ stonks -r AMD`
Remove a favourite stock
### `$ stonks AMD`
Gives the current stock for each ticker passed that day
### `$ stonks -w AMD`
Gives the current stock for each ticker passed _for the past week_
### `$ stonks -d 4 AMD`
Gives the current stock for each ticker passed X days ago
## Configuration
The config file is located at `~/.config/stonks.yml`
You can change the following options:
```yml
config:
default_theme: 0 # 0: Line, 1: Dots, 2: Icons
favourites_height: 12 # Height of the chart in each info panel
standalone_height: 12
```
## Usage with wtfutil
You can use a program such as [wtfutil](https://wtfutil.com/) (On Arch Linux: `yup -S wtfutil`) to make stonks refresh automatically.
See the sample `~/.config/wtf/config.yml` provided by [Gideon Wolfe
](https://github.com/GideonWolfe):
```yml
wtf:
colors:
background: black
border:
focusable: darkslateblue
focused: blue
normal: gray
checked: yellow
highlight:
fore: black
back: gray
rows:
even: yellow
odd: white
grid:
# How _wide_ the columns are, in terminal characters. In this case we have
# four columns, each of which are 35 characters wide.
columns: [33, 33, 33]
# How _high_ the rows are, in terminal lines. In this case we have four rows
# that support ten line of text and one of four.
rows: [20, 20, 20, 20, 20, 20, 20, 20]
refreshInterval: 1
mods:
tech:
type: cmdrunner
args: ["tsla", "intc", "--theme", "dot"]
cmd: "stonks"
enabled: true
position:
top: 0
left: 0
height: 2
width: 3
refreshInterval: 10
title: "🤖 Tech"
financial:
type: cmdrunner
args: ["jpm", "v", "--theme", "dot"]
cmd: "stonks"
enabled: true
position:
top: 2
left: 0
height: 2
width: 3
refreshInterval: 10
```