{"id":13393505,"url":"https://github.com/ericm/stonks","last_synced_at":"2025-10-27T10:11:12.608Z","repository":{"id":44753532,"uuid":"263708389","full_name":"ericm/stonks","owner":"ericm","description":"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.","archived":false,"fork":false,"pushed_at":"2023-05-22T22:51:18.000Z","size":1862,"stargazers_count":556,"open_issues_count":4,"forks_count":34,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-28T17:11:16.388Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://stonks.icu","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ericm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-05-13T18:12:12.000Z","updated_at":"2025-03-14T17:23:03.000Z","dependencies_parsed_at":"2024-01-14T09:57:33.487Z","dependency_job_id":"c7cc5727-3c50-45ad-bf31-42e5969771da","html_url":"https://github.com/ericm/stonks","commit_stats":{"total_commits":123,"total_committers":7,"mean_commits":"17.571428571428573","dds":"0.13008130081300817","last_synced_commit":"ac6b1c05a4f006d0610e8caf589aa77d74ae3245"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericm%2Fstonks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericm%2Fstonks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericm%2Fstonks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericm%2Fstonks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ericm","download_url":"https://codeload.github.com/ericm/stonks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226215,"owners_count":20904465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-07-30T17:00:54.548Z","updated_at":"2025-10-27T10:11:12.535Z","avatar_url":"https://github.com/ericm.png","language":"Go","readme":"# ![Stonks](./assets/stonks.svg?raw=true)\n\n[![GitHub](https://img.shields.io/github/license/ericm/stonks?style=for-the-badge)](https://github.com/ericm/stonks/blob/master/LICENSE)\n[![GitHub contributors](https://img.shields.io/github/contributors/ericm/stonks?style=for-the-badge)](https://github.com/ericm/stonks/graphs/contributors)\n[![GitHub last commit](https://img.shields.io/github/last-commit/ericm/stonks?style=for-the-badge)](https://github.com/ericm/stonks/commits/master)\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ericm/stonks?style=for-the-badge)](https://github.com/ericm/stonks/releases)\n[![AUR version](https://img.shields.io/aur/version/stonks?style=for-the-badge)](https://aur.archlinux.org/packages/stonks/)\n\nStonks is a terminal based stock visualizer and tracker.\n\n## Installation\n\nRequirements: golang \u003e= 1.13\n\n### Manual\n\n1. Clone the repo\n2. Run `make \u0026\u0026 make install`\n\n### Packages\n\nStonks is available on:\n\n- [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`\n\n- HomeBrew: `brew install ericm/stonks/stonks`\n\n### Binaries\n\nBinaries are now available for Windows, MacOSX and Linux under each [release](https://github.com/ericm/stonks/releases)\n\n## [Online installationless usage (via curl)](http://stonks.icu)\n\nYou can now access basic stock graphs for passed stock tickers via the stonks HTTPS client (https://stonks.icu).\n\nTry it:\n```\n$ curl -L stonks.icu/amd/ba\n```\n\n## Usage\n\nIt uses Yahoo Finance as a backend so use the ticker format as seen on their website.\n\n```\nDisplays realtime stocks in graph format in a terminal\n\nUsage:\n  stonks [flags]\n\nFlags:\n  -d, --days int          24 hour period of stocks from X of days ago.\n  -e, --extra             Include extra pre + post time. (Only works for day)\n  -h, --help              help for stonks\n  -i, --interval string   stonks -i X[m|h] (eg 15m, 5m, 1h, 1d) (default \"15m\")\n  -n, --name string       Optional name for a stonk save\n  -r, --remove string     Remove an item from favourites\n  -s, --save string       Add an item to the default stonks command. (Eg: -s AMD -n \"Advanced Micro Devices\")\n  -t, --theme string      Display theme for the chart (Options: \"line\", \"dot\", \"icon\")\n  -v, --version           stonks version\n  -w, --week              Display the last week (will set interval to 1d)\n  -y, --year              Display the last year (will set interval to 5d)\n      --ytd               Display the year to date (will set interval to 5d)\n```\n\n### `$ stonks`\n\nGives graphs and current value/change of _saved_ stocks.\n![Stonks](./assets/1.png)\n\n### `$ stonks -s AMD -n \"Advanced Micro Devices\"`\n\nAdd a favourite stock to be tracked with `$ stonks`\n\n### `$ stonks -r AMD`\n\nRemove a favourite stock\n\n### `$ stonks AMD`\n\nGives the current stock for each ticker passed that day\n\n![Stonks](./assets/2.png)\n\n### `$ stonks -w AMD`\n\nGives the current stock for each ticker passed _for the past week_\n\n![Stonks](./assets/3.png)\n\n### `$ stonks -d 4 AMD`\n\nGives the current stock for each ticker passed X days ago\n\n![Stonks](./assets/4.png)\n\n## Configuration\n\nThe config file is located at `~/.config/stonks.yml`\n\nYou can change the following options:\n\n```yml\nconfig:\n  default_theme: 0 # 0: Line, 1: Dots, 2: Icons\n  favourites_height: 12 # Height of the chart in each info panel\n  standalone_height: 12\n```\n\n## Usage with wtfutil\n\nYou can use a program such as [wtfutil](https://wtfutil.com/) (On Arch Linux: `yup -S wtfutil`) to make stonks refresh automatically.\nSee the sample `~/.config/wtf/config.yml` provided by [Gideon Wolfe\n](https://github.com/GideonWolfe):\n\n```yml\nwtf:\n  colors:\n    background: black\n    border:\n      focusable: darkslateblue\n      focused: blue\n      normal: gray\n    checked: yellow\n    highlight:\n      fore: black\n      back: gray\n    rows:\n      even: yellow\n      odd: white\n  grid:\n    # How _wide_ the columns are, in terminal characters. In this case we have\n    # four columns, each of which are 35 characters wide.\n    columns: [33, 33, 33]\n    # How _high_ the rows are, in terminal lines. In this case we have four rows\n    # that support ten line of text and one of four.\n    rows: [20, 20, 20, 20, 20, 20, 20, 20]\n  refreshInterval: 1\n\n  mods:\n    tech:\n      type: cmdrunner\n      args: [\"tsla\", \"intc\", \"--theme\", \"dot\"]\n      cmd: \"stonks\"\n      enabled: true\n      position:\n        top: 0\n        left: 0\n        height: 2\n        width: 3\n      refreshInterval: 10\n      title: \"🤖 Tech\"\n    financial:\n      type: cmdrunner\n      args: [\"jpm\", \"v\", \"--theme\", \"dot\"]\n      cmd: \"stonks\"\n      enabled: true\n      position:\n        top: 2\n        left: 0\n        height: 2\n        width: 3\n      refreshInterval: 10\n```\n","funding_links":[],"categories":["Go","ASCII UI/UX Apps"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericm%2Fstonks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fericm%2Fstonks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericm%2Fstonks/lists"}