diff --git a/docs/build-for-developers/cli-usage.md b/docs/build-for-developers/cli-usage.md index 7cdef3c3176..33534b86367 100644 --- a/docs/build-for-developers/cli-usage.md +++ b/docs/build-for-developers/cli-usage.md @@ -4,10 +4,15 @@ sidebar_label: Basic usage slug: /cli-usage --- -This page shows common usage examples for the CLI. +This page shows examples for some of the most common usages of the CLI, including: -Execute a job, run a workflow, adjust logging, maintain adaptors, and save the -state. +- get help +- run a job +- saving the state +- adjust logging level +- maintain adaptors repo +- run a workflow +- load adaptor documentation --- @@ -25,9 +30,7 @@ openfn deploy --help ### Run a job -To run a single job, you must explicitly specify which adaptor to use. You can -find the list of publicly available [adaptors here](/adaptors). See examples -below. +To run a single job, you must explicitly specify which adaptor to use - see the [publicly available adaptors](/adaptors). Adaptors are automatically installed if the specified version is not detected. @@ -174,7 +177,7 @@ openfn repo clean ### Run a workflow
- A workflow has a structure like this + Click to view an example workflow's JSON structure ```json {