Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up and organize list of commonly used CLI features in cli-usage.md #543

Merged
merged 2 commits into from
Sep 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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