Working with CLI
The Command-Line interface is a vital part for the Frictionless Framework. While working within Python provides more flexibility, CLI is the easist way to interact with Frictionless.
#
InstallTo install the package please follow the Quick Start guide. Usually, a simple installation using Pip or Anaconda will install the frictionless
binary on your computer so you don't need to install CLI aditionally.
#
CommandsThe frictionless
binary requires providing a command like describe
or validate
:
#
ArgumentsAll the arguments for the main CLI command are the same as they are in Python. You can read Guides and use almost all the information from there within the command-line. There is an important different in how arguments are written (note the dashes):
To get help for a command and its arguments you can use the help flag with the command:
#
OutputsUsually, Frictionless commands returns pretty-formatted tabular data like extract
or validate
do. For the describe
command you get a metadata back and you can choose in what format to return it:
#
ErrorsThe Frictionless' CLI interface should not fail with any internal Python errors with a traceback (a long listing of related code). If you see something like this please create an issue in the Issue Tracker.