PeepDB-dev / peepdb

CLI tool and python library to inspect databases fast.
https://docs.peepdb.dev/
GNU General Public License v3.0
289 stars 15 forks source link

Create Man page for all the available CLI commands #32

Closed Aherontas closed 1 month ago

Aherontas commented 1 month ago

Typical format to follow: (with examples per DB)

NAME command - brief description of the command.

SYNOPSIS command [options] [arguments]

DESCRIPTION Detailed description of what the command does, its features, and any important information.

OPTIONS -h, --help Show help for the command.

   -v, --version
          Display the version of the command.

   -o, --output <file>
          Specify an output file.

   -f, --force
          Force the operation, ignoring warnings.

   -q, --quiet
          Suppress output messages.

   --config <file>
          Use the specified configuration file.
Aherontas commented 1 month ago

I will create that .