Skip to content

Commit

Permalink
Merge pull request #543 from DrCord/patch-5
Browse files Browse the repository at this point in the history
Clean up and organize list of commonly used CLI features in cli-usage.md
  • Loading branch information
josephjclark committed Sep 16, 2024
2 parents 54d81b3 + e2483d1 commit 3abca04
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions docs/build-for-developers/cli-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand All @@ -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.

Expand Down Expand Up @@ -174,7 +177,7 @@ openfn repo clean
### Run a workflow

<details>
<summary>A workflow has a structure like this</summary>
<summary>Click to view an example workflow's JSON structure</summary>

```json
{
Expand Down

0 comments on commit 3abca04

Please sign in to comment.