Skip to content

Commit 8613330

Browse files
author
Paul Le Cam
committed
Update CLI links
1 parent 2296db9 commit 8613330

2 files changed

Lines changed: 55 additions & 53 deletions

File tree

packages/cli/README.md

Lines changed: 52 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,32 @@ idx COMMAND
1313
```
1414

1515
<!-- commands -->
16-
* [`idx bootstrap`](#idx-bootstrap)
17-
* [`idx config:get KEY`](#idx-configget-key)
18-
* [`idx config:reset KEY`](#idx-configreset-key)
19-
* [`idx config:set KEY VALUE`](#idx-configset-key-value)
20-
* [`idx config:show`](#idx-configshow)
21-
* [`idx definition:check ID`](#idx-definitioncheck-id)
22-
* [`idx definition:create DID`](#idx-definitioncreate-did)
23-
* [`idx definition:info ID`](#idx-definitioninfo-id)
24-
* [`idx definition:schema ID`](#idx-definitionschema-id)
25-
* [`idx did:create`](#idx-didcreate)
26-
* [`idx did:delete DID`](#idx-diddelete-did)
27-
* [`idx did:label DID [LABEL]`](#idx-didlabel-did-label)
28-
* [`idx did:list`](#idx-didlist)
29-
* [`idx did:sign DID CONTENTS`](#idx-didsign-did-contents)
30-
* [`idx did:verify JWS`](#idx-didverify-jws)
31-
* [`idx help [COMMAND]`](#idx-help-command)
32-
* [`idx index:get DID KEY`](#idx-indexget-did-key)
33-
* [`idx index:inspect DID`](#idx-indexinspect-did)
34-
* [`idx index:merge DID KEY CONTENTS`](#idx-indexmerge-did-key-contents)
35-
* [`idx index:set DID KEY CONTENTS`](#idx-indexset-did-key-contents)
36-
* [`idx schema:publish DID SCHEMA`](#idx-schemapublish-did-schema)
37-
* [`idx tile:create DID CONTENTS`](#idx-tilecreate-did-contents)
38-
* [`idx tile:get ID`](#idx-tileget-id)
39-
* [`idx tile:merge DID ID CONTENTS`](#idx-tilemerge-did-id-contents)
40-
* [`idx tile:set DID ID CONTENTS`](#idx-tileset-did-id-contents)
16+
17+
- [`idx bootstrap`](#idx-bootstrap)
18+
- [`idx config:get KEY`](#idx-configget-key)
19+
- [`idx config:reset KEY`](#idx-configreset-key)
20+
- [`idx config:set KEY VALUE`](#idx-configset-key-value)
21+
- [`idx config:show`](#idx-configshow)
22+
- [`idx definition:check ID`](#idx-definitioncheck-id)
23+
- [`idx definition:create DID`](#idx-definitioncreate-did)
24+
- [`idx definition:info ID`](#idx-definitioninfo-id)
25+
- [`idx definition:schema ID`](#idx-definitionschema-id)
26+
- [`idx did:create`](#idx-didcreate)
27+
- [`idx did:delete DID`](#idx-diddelete-did)
28+
- [`idx did:label DID [LABEL]`](#idx-didlabel-did-label)
29+
- [`idx did:list`](#idx-didlist)
30+
- [`idx did:sign DID CONTENTS`](#idx-didsign-did-contents)
31+
- [`idx did:verify JWS`](#idx-didverify-jws)
32+
- [`idx help [COMMAND]`](#idx-help-command)
33+
- [`idx index:get DID KEY`](#idx-indexget-did-key)
34+
- [`idx index:inspect DID`](#idx-indexinspect-did)
35+
- [`idx index:merge DID KEY CONTENTS`](#idx-indexmerge-did-key-contents)
36+
- [`idx index:set DID KEY CONTENTS`](#idx-indexset-did-key-contents)
37+
- [`idx schema:publish DID SCHEMA`](#idx-schemapublish-did-schema)
38+
- [`idx tile:create DID CONTENTS`](#idx-tilecreate-did-contents)
39+
- [`idx tile:get ID`](#idx-tileget-id)
40+
- [`idx tile:merge DID ID CONTENTS`](#idx-tilemerge-did-id-contents)
41+
- [`idx tile:set DID ID CONTENTS`](#idx-tileset-did-id-contents)
4142

4243
## `idx bootstrap`
4344

@@ -51,7 +52,7 @@ OPTIONS
5152
-c, --ceramic=ceramic Ceramic API URL
5253
```
5354

54-
_See code: [src/commands/bootstrap.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/bootstrap.ts)_
55+
_See code: [src/commands/bootstrap.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/bootstrap.ts)_
5556

5657
## `idx config:get KEY`
5758

@@ -65,7 +66,7 @@ OPTIONS
6566
-c, --ceramic=ceramic Ceramic API URL
6667
```
6768

68-
_See code: [src/commands/config/get.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/config/get.ts)_
69+
_See code: [src/commands/config/get.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/config/get.ts)_
6970

7071
## `idx config:reset KEY`
7172

@@ -79,7 +80,7 @@ OPTIONS
7980
-c, --ceramic=ceramic Ceramic API URL
8081
```
8182

82-
_See code: [src/commands/config/reset.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/config/reset.ts)_
83+
_See code: [src/commands/config/reset.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/config/reset.ts)_
8384

8485
## `idx config:set KEY VALUE`
8586

@@ -93,7 +94,7 @@ OPTIONS
9394
-c, --ceramic=ceramic Ceramic API URL
9495
```
9596

96-
_See code: [src/commands/config/set.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/config/set.ts)_
97+
_See code: [src/commands/config/set.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/config/set.ts)_
9798

9899
## `idx config:show`
99100

@@ -107,7 +108,7 @@ OPTIONS
107108
-c, --ceramic=ceramic Ceramic API URL
108109
```
109110

110-
_See code: [src/commands/config/show.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/config/show.ts)_
111+
_See code: [src/commands/config/show.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/config/show.ts)_
111112

112113
## `idx definition:check ID`
113114

@@ -124,7 +125,7 @@ OPTIONS
124125
-c, --ceramic=ceramic Ceramic API URL
125126
```
126127

127-
_See code: [src/commands/definition/check.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/definition/check.ts)_
128+
_See code: [src/commands/definition/check.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/definition/check.ts)_
128129

129130
## `idx definition:create DID`
130131

@@ -145,7 +146,7 @@ OPTIONS
145146
-u, --url=url documentation URL for the definition
146147
```
147148

148-
_See code: [src/commands/definition/create.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/definition/create.ts)_
149+
_See code: [src/commands/definition/create.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/definition/create.ts)_
149150

150151
## `idx definition:info ID`
151152

@@ -162,7 +163,7 @@ OPTIONS
162163
-c, --ceramic=ceramic Ceramic API URL
163164
```
164165

165-
_See code: [src/commands/definition/info.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/definition/info.ts)_
166+
_See code: [src/commands/definition/info.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/definition/info.ts)_
166167

167168
## `idx definition:schema ID`
168169

@@ -179,7 +180,7 @@ OPTIONS
179180
-c, --ceramic=ceramic Ceramic API URL
180181
```
181182

182-
_See code: [src/commands/definition/schema.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/definition/schema.ts)_
183+
_See code: [src/commands/definition/schema.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/definition/schema.ts)_
183184

184185
## `idx did:create`
185186

@@ -195,7 +196,7 @@ OPTIONS
195196
-s, --seed=seed base16-encoded seed to use for the DID
196197
```
197198

198-
_See code: [src/commands/did/create.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/did/create.ts)_
199+
_See code: [src/commands/did/create.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/did/create.ts)_
199200

200201
## `idx did:delete DID`
201202

@@ -210,7 +211,7 @@ OPTIONS
210211
-f, --force bypass confirmation prompt
211212
```
212213

213-
_See code: [src/commands/did/delete.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/did/delete.ts)_
214+
_See code: [src/commands/did/delete.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/did/delete.ts)_
214215

215216
## `idx did:label DID [LABEL]`
216217

@@ -225,7 +226,7 @@ OPTIONS
225226
-d, --delete delete the label
226227
```
227228

228-
_See code: [src/commands/did/label.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/did/label.ts)_
229+
_See code: [src/commands/did/label.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/did/label.ts)_
229230

230231
## `idx did:list`
231232

@@ -239,7 +240,7 @@ OPTIONS
239240
-c, --ceramic=ceramic Ceramic API URL
240241
```
241242

242-
_See code: [src/commands/did/list.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/did/list.ts)_
243+
_See code: [src/commands/did/list.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/did/list.ts)_
243244

244245
## `idx did:sign DID CONTENTS`
245246

@@ -257,7 +258,7 @@ OPTIONS
257258
-c, --ceramic=ceramic Ceramic API URL
258259
```
259260

260-
_See code: [src/commands/did/sign.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/did/sign.ts)_
261+
_See code: [src/commands/did/sign.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/did/sign.ts)_
261262

262263
## `idx did:verify JWS`
263264

@@ -274,7 +275,7 @@ OPTIONS
274275
-c, --ceramic=ceramic Ceramic API URL
275276
```
276277

277-
_See code: [src/commands/did/verify.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/did/verify.ts)_
278+
_See code: [src/commands/did/verify.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/did/verify.ts)_
278279

279280
## `idx help [COMMAND]`
280281

@@ -291,7 +292,7 @@ OPTIONS
291292
--all see all commands in CLI
292293
```
293294

294-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_
295+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/tree/v3.2.2/src/commands/help.ts)_
295296

296297
## `idx index:get DID KEY`
297298

@@ -309,7 +310,7 @@ OPTIONS
309310
-c, --ceramic=ceramic Ceramic API URL
310311
```
311312

312-
_See code: [src/commands/index/get.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/index/get.ts)_
313+
_See code: [src/commands/index/get.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/index/get.ts)_
313314

314315
## `idx index:inspect DID`
315316

@@ -326,7 +327,7 @@ OPTIONS
326327
-c, --ceramic=ceramic Ceramic API URL
327328
```
328329

329-
_See code: [src/commands/index/inspect.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/index/inspect.ts)_
330+
_See code: [src/commands/index/inspect.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/index/inspect.ts)_
330331

331332
## `idx index:merge DID KEY CONTENTS`
332333

@@ -345,7 +346,7 @@ OPTIONS
345346
-c, --ceramic=ceramic Ceramic API URL
346347
```
347348

348-
_See code: [src/commands/index/merge.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/index/merge.ts)_
349+
_See code: [src/commands/index/merge.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/index/merge.ts)_
349350

350351
## `idx index:set DID KEY CONTENTS`
351352

@@ -364,7 +365,7 @@ OPTIONS
364365
-c, --ceramic=ceramic Ceramic API URL
365366
```
366367

367-
_See code: [src/commands/index/set.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/index/set.ts)_
368+
_See code: [src/commands/index/set.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/index/set.ts)_
368369

369370
## `idx schema:publish DID SCHEMA`
370371

@@ -382,7 +383,7 @@ OPTIONS
382383
-c, --ceramic=ceramic Ceramic API URL
383384
```
384385

385-
_See code: [src/commands/schema/publish.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/schema/publish.ts)_
386+
_See code: [src/commands/schema/publish.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/schema/publish.ts)_
386387

387388
## `idx tile:create DID CONTENTS`
388389

@@ -401,7 +402,7 @@ OPTIONS
401402
-s, --schema=schema DocID of the schema validating the contents
402403
```
403404

404-
_See code: [src/commands/tile/create.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/tile/create.ts)_
405+
_See code: [src/commands/tile/create.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/tile/create.ts)_
405406

406407
## `idx tile:get ID`
407408

@@ -419,7 +420,7 @@ OPTIONS
419420
--did=did DID or label
420421
```
421422

422-
_See code: [src/commands/tile/get.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/tile/get.ts)_
423+
_See code: [src/commands/tile/get.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/tile/get.ts)_
423424

424425
## `idx tile:merge DID ID CONTENTS`
425426

@@ -438,7 +439,7 @@ OPTIONS
438439
-c, --ceramic=ceramic Ceramic API URL
439440
```
440441

441-
_See code: [src/commands/tile/merge.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/tile/merge.ts)_
442+
_See code: [src/commands/tile/merge.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/tile/merge.ts)_
442443

443444
## `idx tile:set DID ID CONTENTS`
444445

@@ -457,7 +458,8 @@ OPTIONS
457458
-c, --ceramic=ceramic Ceramic API URL
458459
```
459460

460-
_See code: [src/commands/tile/set.ts](https://github.com/ceramicstudio/idx-cli/blob/v0.6.0/src/commands/tile/set.ts)_
461+
_See code: [src/commands/tile/set.ts](https://github.com/ceramicstudio/js-idx/tree/v0.8.0/packages/cli/src/commands/tile/set.ts)_
462+
461463
<!-- commandsstop -->
462464

463465
## License

packages/cli/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
"version": "0.7.0",
99
"author": "Paul Le Cam <paul@3box.io>",
1010
"license": "(Apache-2.0 OR MIT)",
11-
"repository": "ceramicstudio/idx-cli",
12-
"homepage": "https://github.com/ceramicstudio/idx-cli",
13-
"bugs": "https://github.com/ceramicstudio/idx-cli/issues",
11+
"repository": "ceramicstudio/js-idx",
12+
"homepage": "https://github.com/ceramicstudio/js-idx",
13+
"bugs": "https://github.com/ceramicstudio/js-idx/issues",
1414
"main": "lib/index.js",
1515
"bin": {
1616
"idx": "./bin/run"

0 commit comments

Comments
 (0)