Skip to content

niklasschloegel/parcly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Parcly Image

Parcly

Parcly is a CLI app for tracking parcels.

This app is built with cobra and Tracktry API.

Getting started

Installation

macOS Homebrew

brew tap niklasschloegel/parcly; brew install niklasschloegel/parcly/parcly

With go install

Go installation required

go install github.com/niklasschloegel/parcly@latest

With apt (for Debian based Linux distros)

First you need to add the following line to the file /etc/apt/sources.list.d/fury.list:

deb [trusted=yes] https://apt.fury.io/niklasschloegel/ /

And then install with

sudo apt update; sudo apt install parcly

With yum (for Fedora/CentOS)

Add the following entry to this file /etc/yum.repos.d/fury.repo:

[fury]
name=Gemfury Private Repo
baseurl=https://yum.fury.io/niklasschloegel/
enabled=1
gpgcheck=0

And then install with

sudo yum update; sudo yum install parcly

Setting the API key

To use this app, you need to create a free account at Tracktry. Your API key can be found under Settings/API.

The API Key can be provided in three ways:

  1. As a flag:
parcly <noun> <command> --tracktrykey <key>
  1. As an environment variable:
export PARCLY_TRACKTRYKEY=<key>
  1. In a config file:

default config file is $HOME/.parcly.yaml and should contain:

tracktrykey: <key>

When you want to use another location, you can specify the location with another flag:

parcly ... --config <filepath>
  1. Through the config set command:
parcly config set --tracktry key

Example usage

You first have to add a tracking item:

parcly tracking add <trackingNr> --carrier dhl-germany

The tracking item now gets saved to Tracktry and can get requested afterwards with

parcly tracking list

For more information you can just type

parcly help