CLI Tool for Interacting with the Banco Central de Chile (BCCh) API

General Description

This CLI tool allows you to set credentials and search for available data series from the Banco Central de Chile API using keywords. Once the data series of interest are identified, you can use their IDs to retrieve the corresponding data.

More information about the API can be found at BCCh API para Base de Datos Estadísticos

Reason

One of the beauties of Go is its robust and versatile standard library. I noticed a lack of Go-based implementations for the Banco Central de Chile API, and this inspired me to develop a CLI tool as an entry point. This tool provides an easy-to-use interface, acting as a wrapper over the API to simplify data retrieval and interaction. By doing so, I aimed to explore the abstraction ladder of existing CLI libraries, starting from the Go standard library.

This CLI serves as a foundational project, offering an interactive and streamlined experience for users while also opening the door for future enhancements. It simplifies access to the data series, making it an ideal starting stone for developers looking to extend its capabilities or for anyone needing a convenient way to interact with the API.

Version Roadmap

The first release (v1.x.x) will rely entirely on the Go standard library. Subsequent versions will incrementally incorporate external libraries. Here's the roadmap of tools planned to be used:

• v2.x.x Liner for command line editing with history.
• v3.x.x Cobra for modern Go CLI applications.
• v4.x.x Bubble Tea for interactive CLI applications.
• VHS for documentation

🚀 Quick Start

Request your BCCh credentials

Create an account with the BCCh (Banco Central de Chile) and activate your API credentials.

Download the Executable

Visit the Releases section and download the compressed file that matches your OS/architecture setup. Inside the compressed file, you’ll find the executable.

Start Using the CLI

After unzipping, refer to the executable from your terminal and type commands to get started. Begin with the basics by running:

<executable-file-name> help

Note: To simplify command usage, you can add the executable to your PATH. This allows you to use a shorter command, such as bcch, instead of specifying the full path each time.

BCCh CLI Tool

The BCCh CLI Tool provides an interface for interacting with the Banco Central de Chile API, allowing you to set credentials, search for available data series, and retrieve data using specific series IDs.

🚀 Installation

Provide installation instructions here, such as:

go install github.com/yourusername/bcch-cli

Or any other relevant way to install the tool.

📚 Usage

Available Commands

• help: Display help information for any command.
• setCredentials: Save credentials for BCCh API access locally.
• search: Search the full list of available data series, with options to filter by keywords and frequency.
• get: Retrieve data from a specific data series by series ID.

Flags

• -h, --help - Show help for any command.
• -k, --keyword - Filter search results by keyword (used with the search command).
• -f, --frequency - Filter search results by frequency (DAILY, MONTHLY, ANNUAL) (used with the search command).
• -s, --series - Specify the series ID to retrieve data from (used with the get command).
• -u, --user - User for BCCh API (used with the setCredentials command).
• -p, --password - Password for BCCh API (used with the setCredentials command).

⚡ Examples

Set up Credentials

Save your credentials to be used for BCCh API access:

bcch setCredentials -u myUser -p myPassword

Search for Data Series

Search for monthly inflation data:

bcch search -k "inflation" -f MONTHLY

Retrieve Data from a Specific Series

Retrieve data using a series ID:

bcch get -s "12345-inflation-monthly"

Out of the Box Features

• Caching for repeated requests: Reduce API load and improve performance by caching repeated requests.
• Remember login across new sessions: Automatically remember login credentials for easier access.
• Loading spinner to enhance user experience: Provide visual feedback during data loading to improve user interaction.

Additional Comments

One major reference in terms of structure and the alike are the Docker CLI GitHub repository and BootDev CLI GitHub repository. CI is managed using GitHub Actions. Releases are handled by GoReleaser via GitHub Actions

🤝 Contributing

Follow these steps to get started:

1. Clone the repository

   git clone https://github.com/iferdel/chile-economic-indexes-cli@latest
   cd chile-economic-indexes-cli

2. Build the project

   go build

3. Run the project

   ./chile-economic-indexes-cli

4. Run the tests

   go test ./...

5. Submit a pull request

   If you'd like to contribute, please fork the repository, make your changes, and open a pull request to the main branch.