etf-cli

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2023 License: MIT Imports: 1 Imported by: 0

README

etf-cli

Simple ETF cli that displays ETF data & allows management of tracked etfs. The ETF data is scraped from Yahoo Finance.

Available commands:

  • report - generates a report for the ETFs in the configuration
  • add <etf-symbol> - adds the specified ETF symbol to the configuration. The symbol must exist in Yahoo finance, such as VWCE.DE
  • remove <index> - removes the ETF with the specified index from the configuration
  • list - lists the ETF symbols currently in the configuration
  • help - help command

Installation

Steps:

  1. Download the source code.
  2. Navigate to the root project folder.
  3. Run go build .
  4. Run go install .
  5. You can then run any command using etf-cli [command]

TODO

  • Add functional options pattern for client.go ?
  • Add command to configure the intervals to be displayed for the reports?
  • Investigate how to publish cli by using for example homebrew, goreleaser

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL