Skip to content

Commit 90ee79f

Browse files
Document cli
1 parent 4848114 commit 90ee79f

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,27 @@ encodeTime(1469918176385); // "01ARYZ6S41"
140140

141141
Install dependencies using `npm install` first, and then simply run `npm test` to run the test suite.
142142

143+
### CLI
144+
145+
`ulid` can be used on the command line, either via global install:
146+
147+
```shell
148+
npm install -g ulid
149+
ulid
150+
```
151+
152+
Or via `npx`:
153+
154+
```shell
155+
npx ulid
156+
```
157+
158+
You can also generate multiple IDs at the same time:
159+
160+
```shell
161+
ulid --count 15
162+
```
163+
143164
## Specification
144165

145166
You can find the full specification, as well as information regarding implementations in other languages, over at [ulid/spec](https://github.com/ulid/spec).

0 commit comments

Comments
 (0)