Skip to content

Commit

Permalink
update cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dale-french committed Feb 29, 2024
1 parent 5bff879 commit 93603cd
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,37 @@
# cli
# Opticks CLI

## Usage

```shell
npx opticks-cli clean

// OR

npx opticks clean id=EXPERIMENT-ID winner=A|B
```

## Running locally

First you will need to install dependencies and build the CLI in watch mode

```shell
cd opticks
yarn install
cd packages/cli && yarn build:watch
```
cd packages/cli && node dist/index.js

In a separate terminal window, create a symlink for `opticks-cli`

```shell
cd opticks
npm link
```

Navigate to your consumer project and link `opticks-cli`

```shell
cd opticks-consumer-project
npm link opticks-cli

opticks-cli clean
```

0 comments on commit 93603cd

Please sign in to comment.