Skip to content

Commit 4cad995

Browse files
yaziineyaziine
authored
chore: fix documentation (#202)
1 parent 3ce6ad6 commit 4cad995

13 files changed

Lines changed: 218 additions & 25 deletions

‎docs/imports.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Once the import file is valid, the file can be uploaded to be scheduled for impo
167167
<summary>`upload-import` example</summary>
168168

169169
```shell
170-
$ stream-cli chat upload-import my-data.json 10:14:36
170+
$ stream-cli import chat upload-import my-data.json 10:14:36
171171
{
172172
"created_at": "2022-05-16T09:02:37.991181Z",
173173
"path": "s3://stream-import/1171432/7e7fbaf4-e266-4877-96da-fbacf650d0a1/my-data.json",
@@ -192,7 +192,7 @@ pre-existing items.
192192
<summary>import modes example</summary>
193193

194194
```shell
195-
$ stream-cli chat upload-import valid-data.json --mode insert 11:02:44
195+
$ stream-cli import chat upload-import valid-data.json --mode insert 11:02:44
196196
{
197197
"created_at": "2022-05-16T09:06:26.356475Z",
198198
"path": "s3://stream-import/1171432/f9460261-ce3c-4594-a236-33bbedfa85a7/valid-data.json",
@@ -221,7 +221,7 @@ Once an import has been created, you can monitor its status using the `get-impor
221221
<summary>`get-import` example</summary>
222222

223223
```shell
224-
$ stream-cli chat get-import f0077dab-84f3-48f1-9292-2bf1b48fd6f0 --watch 13:50:09
224+
$ stream-cli import chat get-import f0077dab-84f3-48f1-9292-2bf1b48fd6f0 --watch 13:50:09
225225
{
226226
"import_task": {
227227
"created_at": "2022-05-16T09:06:26.356475Z",
@@ -249,7 +249,7 @@ $ stream-cli chat get-import f0077dab-84f3-48f1-9292-2bf1b48fd6f0 --watch
249249
<summary>`list-imports` example</summary>
250250

251251
```shell
252-
$ stream-cli chat list-imports 130 ↵ 13:51:07
252+
$ stream-cli import chat list-imports 130 ↵ 13:51:07
253253
[
254254
{
255255
"created_at": "2022-05-16T09:06:26.356475Z",

‎docs/stream-cli.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ $ stream-cli chat list-channel-types
1818
# Create a new Chat user
1919
$ stream-cli chat upsert-user --properties "{\"id\":\"my-user-1\"}"
2020
21+
# Upload a chat import
22+
$ stream-cli import chat upload-import data.json --mode insert
23+
24+
# Upload a feeds import
25+
$ stream-cli import feeds upload-import data.json
26+
2127
```
2228

2329
### Options
@@ -32,4 +38,5 @@ $ stream-cli chat upsert-user --properties "{\"id\":\"my-user-1\"}"
3238

3339
* [stream-cli chat](stream-cli_chat.md) - Allows you to interact with your Chat applications
3440
* [stream-cli config](stream-cli_config.md) - Manage app configurations
41+
* [stream-cli import](stream-cli_import.md) - Import data into your Stream applications
3542

‎docs/stream-cli_chat.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,13 @@ Allows you to interact with your Chat applications
4141
* [stream-cli chat get-app](stream-cli_chat_get-app.md) - Get application settings
4242
* [stream-cli chat get-channel](stream-cli_chat_get-channel.md) - Return a channel
4343
* [stream-cli chat get-channel-type](stream-cli_chat_get-channel-type.md) - Get channel type
44-
* [stream-cli chat get-import](stream-cli_chat_get-import.md) - Get import
4544
* [stream-cli chat get-message](stream-cli_chat_get-message.md) - Return a single message
4645
* [stream-cli chat get-messages](stream-cli_chat_get-messages.md) - Return multiple messages
4746
* [stream-cli chat get-reactions](stream-cli_chat_get-reactions.md) - Get reactions for a message
4847
* [stream-cli chat hide-channel](stream-cli_chat_hide-channel.md) - Hide a channel
4948
* [stream-cli chat list-channel-types](stream-cli_chat_list-channel-types.md) - List channel types
5049
* [stream-cli chat list-channels](stream-cli_chat_list-channels.md) - List channels
5150
* [stream-cli chat list-devices](stream-cli_chat_list-devices.md) - List devices
52-
* [stream-cli chat list-imports](stream-cli_chat_list-imports.md) - List imports
5351
* [stream-cli chat list-pushproviders](stream-cli_chat_list-pushproviders.md) - List all push providers
5452
* [stream-cli chat listen-events](stream-cli_chat_listen-events.md) - Listen to events
5553
* [stream-cli chat mute-user](stream-cli_chat_mute-user.md) - Mute a user
@@ -74,7 +72,6 @@ Allows you to interact with your Chat applications
7472
* [stream-cli chat update-user-partial](stream-cli_chat_update-user-partial.md) - Partially update a user
7573
* [stream-cli chat upload-file](stream-cli_chat_upload-file.md) - Upload a file
7674
* [stream-cli chat upload-image](stream-cli_chat_upload-image.md) - Upload an image
77-
* [stream-cli chat upload-import](stream-cli_chat_upload-import.md) - Upload an import
7875
* [stream-cli chat upsert-pushprovider](stream-cli_chat_upsert-pushprovider.md) - Create or updates a push provider
7976
* [stream-cli chat upsert-user](stream-cli_chat_upsert-user.md) - Upsert a user
8077
* [stream-cli chat watch](stream-cli_chat_watch.md) - Wait for an async task to complete

‎docs/stream-cli_import.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## stream-cli import
2+
3+
Import data into your Stream applications
4+
5+
### Options
6+
7+
```
8+
-h, --help help for import
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
--app string [optional] Application name to use as it's defined in the configuration file
15+
--config string [optional] Explicit config file path
16+
```
17+
18+
### SEE ALSO
19+
20+
* [stream-cli](stream-cli.md) - Stream CLI
21+
* [stream-cli import chat](stream-cli_import_chat.md) - Import data into Chat
22+
* [stream-cli import feeds](stream-cli_import_feeds.md) - Import data into Feeds
23+

‎docs/stream-cli_import_chat.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## stream-cli import chat
2+
3+
Import data into Chat
4+
5+
### Options
6+
7+
```
8+
-h, --help help for chat
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
--app string [optional] Application name to use as it's defined in the configuration file
15+
--config string [optional] Explicit config file path
16+
```
17+
18+
### SEE ALSO
19+
20+
* [stream-cli import](stream-cli_import.md) - Import data into your Stream applications
21+
* [stream-cli import chat get-import](stream-cli_import_chat_get-import.md) - Get import
22+
* [stream-cli import chat list-imports](stream-cli_import_chat_list-imports.md) - List imports
23+
* [stream-cli import chat upload-import](stream-cli_import_chat_upload-import.md) - Upload an import
24+

docs/stream-cli_chat_get-import.md renamed to docs/stream-cli_import_chat_get-import.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
## stream-cli chat get-import
1+
## stream-cli import chat get-import
22

33
Get import
44

55
```
6-
stream-cli chat get-import [import-id] --output-format [json|tree] --watch [flags]
6+
stream-cli import chat get-import [import-id] --output-format [json|tree] --watch [flags]
77
```
88

99
### Examples
1010

1111
```
1212
# Returns an import and prints it as JSON
13-
$ stream-cli chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272
13+
$ stream-cli import chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272
1414
1515
# Returns an import and prints it as JSON, and wait for it to complete
16-
$ stream-cli chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
16+
$ stream-cli import chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
1717
1818
```
1919

@@ -34,5 +34,5 @@ $ stream-cli chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
3434

3535
### SEE ALSO
3636

37-
* [stream-cli chat](stream-cli_chat.md) - Allows you to interact with your Chat applications
37+
* [stream-cli import chat](stream-cli_import_chat.md) - Import data into Chat
3838

docs/stream-cli_chat_list-imports.md renamed to docs/stream-cli_import_chat_list-imports.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
## stream-cli chat list-imports
1+
## stream-cli import chat list-imports
22

33
List imports
44

55
```
6-
stream-cli chat list-imports --offset [int] --limit [int] --output-format [json|tree] [flags]
6+
stream-cli import chat list-imports --offset [int] --limit [int] --output-format [json|tree] [flags]
77
```
88

99
### Examples
1010

1111
```
1212
# List all imports as json (default)
13-
$ stream-cli chat list-imports
13+
$ stream-cli import chat list-imports
1414
1515
# List all imports as browsable tree
16-
$ stream-cli chat list-imports --output-format tree
16+
$ stream-cli import chat list-imports --output-format tree
1717
1818
```
1919

@@ -35,5 +35,5 @@ $ stream-cli chat list-imports --output-format tree
3535

3636
### SEE ALSO
3737

38-
* [stream-cli chat](stream-cli_chat.md) - Allows you to interact with your Chat applications
38+
* [stream-cli import chat](stream-cli_import_chat.md) - Import data into Chat
3939

docs/stream-cli_chat_upload-import.md renamed to docs/stream-cli_import_chat_upload-import.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
## stream-cli chat upload-import
1+
## stream-cli import chat upload-import
22

33
Upload an import
44

55
```
6-
stream-cli chat upload-import [filename] --mode [upsert|insert] --output-format [json|tree] [flags]
6+
stream-cli import chat upload-import [filename] --mode [upsert|insert] --output-format [json|tree] [flags]
77
```
88

99
### Examples
1010

1111
```
1212
# Uploads an import and prints it as JSON
13-
$ stream-cli chat upload-import data.json --mode insert
13+
$ stream-cli import chat upload-import data.json --mode insert
1414
1515
# Uploads an import and prints it as a browsable tree
16-
$ stream-cli chat upload-import data.json --mode insert --output-format tree
16+
$ stream-cli import chat upload-import data.json --mode insert --output-format tree
1717
1818
```
1919

@@ -22,7 +22,8 @@ $ stream-cli chat upload-import data.json --mode insert --output-format tree
2222
```
2323
-h, --help help for upload-import
2424
--lighter-validation-id [optional] allows to pass ! in channel ID
25-
-m, --mode string [optional] Import mode. Canbe upsert or insert (default "upsert")
25+
--merge-custom [optional] Merge custom data during import
26+
-m, --mode string [optional] Import mode. Can be upsert or insert (default "upsert")
2627
-o, --output-format string [optional] Output format. Can be json or tree (default "json")
2728
```
2829

@@ -35,5 +36,5 @@ $ stream-cli chat upload-import data.json --mode insert --output-format tree
3536

3637
### SEE ALSO
3738

38-
* [stream-cli chat](stream-cli_chat.md) - Allows you to interact with your Chat applications
39+
* [stream-cli import chat](stream-cli_import_chat.md) - Import data into Chat
3940

‎docs/stream-cli_import_feeds.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## stream-cli import feeds
2+
3+
Import data into Feeds
4+
5+
### Options
6+
7+
```
8+
-h, --help help for feeds
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
--app string [optional] Application name to use as it's defined in the configuration file
15+
--config string [optional] Explicit config file path
16+
```
17+
18+
### SEE ALSO
19+
20+
* [stream-cli import](stream-cli_import.md) - Import data into your Stream applications
21+
* [stream-cli import feeds get-import](stream-cli_import_feeds_get-import.md) - Get a feeds import task
22+
* [stream-cli import feeds list-imports](stream-cli_import_feeds_list-imports.md) - List feeds import tasks
23+
* [stream-cli import feeds upload-import](stream-cli_import_feeds_upload-import.md) - Upload an import for Feeds
24+

‎docs/stream-cli_import_feeds_get-import.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stream-cli import feeds get-import
2+
3+
Get a feeds import task
4+
5+
```
6+
stream-cli import feeds get-import [task-id] --output-format [json|tree] --watch [flags]
7+
```
8+
9+
### Examples
10+
11+
```
12+
# Returns a feeds import and prints it as JSON
13+
$ stream-cli import feeds get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272
14+
15+
# Returns a feeds import and watches for completion
16+
$ stream-cli import feeds get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
17+
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help help for get-import
24+
-o, --output-format string [optional] Output format. Can be json or tree (default "json")
25+
-w, --watch [optional] Keep polling the import to track its status
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
--app string [optional] Application name to use as it's defined in the configuration file
32+
--config string [optional] Explicit config file path
33+
```
34+
35+
### SEE ALSO
36+
37+
* [stream-cli import feeds](stream-cli_import_feeds.md) - Import data into Feeds
38+

0 commit comments

Comments
 (0)