https://github.com/brunoprietog/stocksy
Command line tool to get stock market data
https://github.com/brunoprietog/stocksy
alpha-vantage alphavantage cli stock-market
Last synced: 17 days ago
JSON representation
Command line tool to get stock market data
- Host: GitHub
- URL: https://github.com/brunoprietog/stocksy
- Owner: brunoprietog
- License: mit
- Created: 2023-09-02T23:10:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-03T18:17:46.000Z (about 2 years ago)
- Last Synced: 2025-09-07T23:56:53.994Z (28 days ago)
- Topics: alpha-vantage, alphavantage, cli, stock-market
- Language: Ruby
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Stocksy
Stocksy is a command line tool that displays stock market information obtained from the [Alpha Vantage API](https://www.alphavantage.co/).
## Installation
Install the gem by executing:
$ gem install stocksy
## Usage
Get a free API key from [Alpha Vantage](https://www.alphavantage.co/) and set it up with `stocksy login [API key]` or with the "ALPHA_VANTAGE_API_KEY" environment variable so Stocksy can get data.
You can review the full list of commands by running `stocksy help`.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/brunoprietog/stocksy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/brunoprietog/stocksy/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Stocksy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/brunoprietog/stocksy/blob/master/CODE_OF_CONDUCT.md).