Gloom is an open-source financial terminal designed to provide users with powerful tools for financial analysis and data visualization. Key features include:
- News Aggregation: Utilize Google Gemini to scrape all RSS news articles and read them in one place.
- Open Source: Fully open-source and customizable to suit your needs, view the default configuration to get started.
To run Gloom, you need to set the following environment variables:
| Variable Name | Description |
|---|---|
GEMINI_KEY |
API Key for using Google Gemini to web scrape articles |
SSH_HOST |
URL to expose the SSH server (optional |
SSH_PORT |
Port to expose the SSH server (optional) |
FMP_KEY |
FinancialModelingPrep API Key, used for stock search |
Make sure to set these variables in your environment before starting the application.
NOTE: The SSH_HOST and SSH_PORT variables are optional, when not set
the application will run as a local application in the terminal you created the
process in.
- Clone the repository:
git clone https://github.com/akayy-dev/gloom.git
- Install dependencies:
cd gloom go mod tidy - Set the required environment variables.
- Start the application:
go run ./cmd/ui
You can configure the behavior of the app using a config.json file. Gloom searches in $HOME/.config/gloom/ for the config file. A default config file with documentation can be found here