Skip to content

Commit

Permalink
Improve docs [ci skip]
Browse files Browse the repository at this point in the history
Signed-off-by: Paolo Di Tommaso <[email protected]>
  • Loading branch information
pditommaso committed Jul 30, 2024
1 parent c4d407f commit 7703f0d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ You can also use a different plugin registry with the `NXF_PLUGINS_TEST_REPOSITO
For example:

```bash
# custom registry at https://github.com/my-org/plugins
# custom plugin repository at https://github.com/my-org/plugins
export NXF_PLUGINS_TEST_REPOSITORY="https://raw.githubusercontent.com/my-org/plugins/main/plugins.json"

# custom plugin release
Expand All @@ -374,6 +374,11 @@ export NXF_PLUGINS_TEST_REPOSITORY="https://github.com/nextflow-io/nf-hello/rele
nextflow run <pipeline> -plugins nf-hello
```

:::{tip}
This variable can be either the URI of a plugins repository JSON file or the URI of a specific plugin JSON meta file.
In the latter case it should match the pattern `https://host.name/some/path/<plugin id>-X.Y.Z-meta.json`.
:::

## Offline usage

To use Nextflow plugins in an offline environment:
Expand Down

0 comments on commit 7703f0d

Please sign in to comment.