1
0
Fork 0
mirror of https://github.com/on4kjm/FLEcli.git synced 2025-01-19 05:01:18 +01:00
FLEcli/doc/usage.md

95 lines
2.3 KiB
Markdown
Raw Normal View History

2020-07-27 22:26:43 +02:00
# Usage
2020-07-27 22:26:43 +02:00
## Overview
```text
2020-07-29 08:22:13 +02:00
A Command Line "Fast Log Entry" (FLE) processor
2020-07-27 22:26:43 +02:00
Usage:
FLEcli [command]
Available Commands:
adif Generates an ADIF file based on a FLE type shorthand logfile.
csv Generates a SOTA .csv file based on a FLE type shorthand logfile.
help Help about any command
load Loads and validates a FLE type shorthand logfile
version "version" will output the current build information
Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
-h, --help help for FLEcli
Use "FLEcli [command] --help" for more information about a command.
```
2020-07-27 22:26:43 +02:00
## "LOAD" command
```text
2020-07-27 22:26:43 +02:00
Loads and validates a FLE type shorthand logfile
Usage:
2020-07-29 08:22:13 +02:00
FLEcli load [flags] inputFile
2020-07-27 22:26:43 +02:00
Flags:
2020-07-29 08:22:13 +02:00
-h, --help help for load
-i, --interpolate Interpolates the missing time entries.
2020-07-27 22:26:43 +02:00
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
2020-07-27 22:26:43 +02:00
## "ADIF" command
```text
2020-07-27 22:26:43 +02:00
Generates an ADIF file based on a FLE type shorthand logfile.
Usage:
2020-07-29 08:22:13 +02:00
FLEcli adif [flags] inputFile [outputFile]
2020-07-27 22:26:43 +02:00
Flags:
2020-07-29 08:22:13 +02:00
-h, --help help for adif
-i, --interpolate Interpolates the missing time entries.
-o, --overwrite Overwrites the output file if it exisits
-p, --pota Generates a POTA ready ADIF file.
2020-07-29 08:22:13 +02:00
-s, --sota Generates a SOTA ready ADIF file.
-w, --wwff Generates a WWFF ready ADIF file.
2020-07-27 22:26:43 +02:00
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
2020-07-27 22:26:43 +02:00
## "CSV" command
```text
2020-07-27 22:26:43 +02:00
Generates a SOTA .csv file based on a FLE type shorthand logfile.
Usage:
2020-07-29 08:22:13 +02:00
FLEcli csv [flags] inputFile [outputFile]
2020-07-27 22:26:43 +02:00
Flags:
2020-07-29 08:22:13 +02:00
-h, --help help for csv
-i, --interpolate Interpolates the missing time entries.
-o, --overwrite Overwrites the output file if it exisits
2020-07-27 22:26:43 +02:00
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
2020-07-27 22:26:43 +02:00
## "VERSION" command
```text
2020-07-27 22:26:43 +02:00
"version" will output the current build information
Usage:
FLEcli version [flags]
Flags:
-d, --detailed Prints the detailed version information
-h, --help help for version
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
2020-07-29 08:22:13 +02:00
The normal output looks like `FLEcli version: v0.1.2`. The detailled output gives additionaly the Git commit hash. the date and time of build and who built the release.