Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.66 KB

README.md

File metadata and controls

45 lines (34 loc) · 1.66 KB

Jaro

Overview

Jaro is a CLI app dev tool for developers who are all things terminal. Jaro can help you get done two things right from your terminal - shorten links and securely transfer files p2p.

Quick demo ✨

jaro.mp4

Usage

To get started with Jaro, pull the Docker image from Docker Hub:

docker pull abdealijaroli/jaro

Configuration

The application inside this container reads its configuration from a single environment variable. You need to provide this variable when running the container.

Required Environment Variable

  • DB_URL: PostgreSQL connection string (e.g., postgresql://user:password@host:port/dbname)

1. Run the server

To run the Jaro application, use the following command, replacing the DB_URL with your actual PostgreSQL connection string:

docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest

2. Shorten a link

docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -s https://example.com

3. Transfer a file

docker run -d --name jaro -e DB_URL=postgresql://user:password@host:port/dbname -p 8008:8008 abdealijaroli/jaro:latest -t /path/to/your/file

Features

  • Link Shortening: Easily shorten URLs directly from your terminal.
  • File Transfer: Transfer files without leaving your command line.

Contributing

If you would like to contribute to Jaro, feel free to submit a pull request or open an issue.

License

This project is open-source and available under the MIT License.