Skip to content
This repository has been archived by the owner on May 17, 2024. It is now read-only.

Commit

Permalink
docs: add note on using an alias
Browse files Browse the repository at this point in the history
  • Loading branch information
nokome committed May 15, 2019
1 parent 70fed89 commit cf98650
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@ You will also need to have [Nix installed](https://nixos.org/nix/download.html):
curl https://nixos.org/nix/install | sh
```

To test the CLI more conveniently you can add an alias to your shell e.g.

```bash
alias nixster='npx ts-node src/cli.ts'
```

Or, if you want to use the CLI outside of this directory:

```bash
alias nixster='/path/to/nixster/node_modules/.bin/ts-node --project /path/to/nixster/tsconfig.json /path/to/nixster/src/cli.ts'
```


### Docker image

Instead of installing Nix and Nixster you can use the `stencila/nixster` Docker image:
Expand Down

0 comments on commit cf98650

Please sign in to comment.