Skip to content

Commit

Permalink
readme: add a couple of cli setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
josephjclark committed Jul 21, 2023
1 parent 3fd064a commit d2aae67
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ machine._
A few first time repo steps:

```
asdf install #Install tool versions
asdf install # Install tool versions
pnpm install
pnpm build
pnpm run setup #Run the setup command
pnpm run setup
```

## Running scripts
Expand Down Expand Up @@ -69,6 +69,14 @@ please make one and assign yourself.

#### 1. Setup

- Make sure you have the OpenFn CLI tool installed
(`npm install -g @openfn/cli`). You'll need this to use and test your adaptor.

- Tell the OpenFn CLI where this repo is by setting the `OPENFN_ADAPTORS_REPO`
environment variable to the local path. For example, if you've cloned this
repo into `/repo/openfn/adaptors`, then in your `.bashrc` file, add
`export OPENFN_ADAPTORS_REPO=/repo/openfn/adaptors`.

- Create a copy of the adaptor [template](packages/template), and rename it.
`cp -R packages/template packages/youradaptorname`

Expand Down Expand Up @@ -100,12 +108,11 @@ getTodaysWeather(25.52, 13.41);

`-O` will output to your console

`-m` will run the job from the monorepo (make sure your monorepo
path is set OPENFN_ADAPTORS_REPO=...)
`-m` will run the job from the monorepo (see the setup notes in 1.)

`-a` this will specify the adaptor to run your job with

- The job should fail - we haven't build the adaptor yet! Let's go do that
- The job should fail - we haven't build the adaptor yet! Let's go do that.

#### 3. Create your adaptor function

Expand Down

0 comments on commit d2aae67

Please sign in to comment.