Skip to content

Commit ed52050

Browse files
committed
Add "experiments plugin" description
1 parent 565572d commit ed52050

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,27 @@ You can reset the configuration to default values.
162162
$ elapi delete config
163163
```
164164

165+
### `experiments` plugin
166+
167+
`experiments` plugin enables experiments-specific actions. You can download an experiment in PDF by its "Unique eLabID"
168+
to `~/Downloads` directory.
169+
170+
```shell
171+
$ elapi experiments get -i <experiment unique elabid> -F pdf --export ~/Downloads/
172+
```
173+
174+
Append text in markdown to an existing experiment by its ID:
175+
176+
```shell
177+
$ elapi experiments append --id <experiment ID> -M -t "**New content.**"
178+
```
179+
180+
You can also upload an attachment to an experiment.
181+
182+
```shell
183+
$ elapi experiments upload-attachment --id <experiment ID> --path <path to attachment file> --comment <comment for your attachment>
184+
```
185+
165186
### Bill teams
166187

167188
You can get a list of all teams and its users for billing purposes and export it to home directory.

0 commit comments

Comments
 (0)