You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-31Lines changed: 48 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# explore-cli
2
2
3
-
Simple utility CLI for importing data into SwaggerHub Explore.
3
+
Simple utility CLI for importing data into API Hub Explore.
4
4
5
5

6
6
@@ -13,7 +13,7 @@ Simple utility CLI for importing data into SwaggerHub Explore.
13
13
|_|
14
14
```
15
15
**Description:**
16
-
> Simple utility CLI for importing data into and out of SwaggerHub Explore
16
+
> Simple utility CLI for importing data into and out of API Hub Explore
17
17
18
18
**Usage:**
19
19
> Explore.CLI [command][options]
@@ -24,20 +24,22 @@ Simple utility CLI for importing data into SwaggerHub Explore.
24
24
> `-?`, `-h`, `--help` Show help and usage information
25
25
26
26
**Commands:**
27
-
> `export-spaces` Export SwaggerHub Explore spaces to filesystem
27
+
> `export-spaces` Export API Hub Explore spaces to filesystem
28
28
>
29
-
> `import-spaces` Import SwaggerHub Explore spaces from a file
29
+
> `import-spaces` Import API Hub Explore spaces from a file
30
30
>
31
-
> `import-postman-collection` Import Postman Collection (v2.1) from a file into SwaggerHub Explore
31
+
> `import-postman-collection` Import Postman Collection (v2.1) from a file into API Hub Explore
32
32
>
33
-
> `import-insomnia-collection` Import Insomnia Collection (v4) from a file into SwaggerHub Explore
33
+
> `import-insomnia-collection` Import Insomnia Collection (v4) from a file into API Hub Explore
34
34
>
35
-
> `import-pact-file` Import a Pact file (v2/v3/v4) into SwaggerHub Explore (HTTP interactions only)
35
+
> `import-pact-file` Import a Pact file (v2/v3/v4) into API Hub Explore (HTTP interactions only)
36
36
37
37
### Prerequisites
38
+
38
39
You will need the following:
40
+
39
41
- .NET 7.0 (or above). Follow instructions for [Windows](https://learn.microsoft.com/en-us/dotnet/core/install/windows?tabs=net70), [Linux](https://learn.microsoft.com/en-us/dotnet/core/install/linux), or [MacOS](https://learn.microsoft.com/en-us/dotnet/core/install/macos).
40
-
- A SwaggerHub Explore account, register at https://try.smartbear.com/swaggerhub-explore (if required).
42
+
- A API Hub Explore account, register at https://try.smartbear.com/swaggerhub-explore (if required).
41
43
42
44
### Install the CLI
43
45
@@ -128,18 +130,20 @@ docker run --platform=linux/amd64 \
128
130
129
131
### Session Cookies for CLI command
130
132
131
-
You will need to obtain certain cookies from an active session in SwaggerHub Explore to invoke the `CLI` commands.
133
+
You will need to obtain certain cookies from an active session in API Hub Explore to invoke the `CLI` commands.
132
134
133
-
From SwaggerHub Explore, navigate to your browser development tools, locate the application cookies and extract the `SESSION` and `XSRF-TOKEN` cookies.
135
+
From API Hub Explore, navigate to your browser development tools, locate the application cookies and extract the `SESSION` and `XSRF-TOKEN` cookies.
134
136
135
137
#### How to get cookie values from your browser
136
138
137
139
##### Keyboard
140
+
138
141
- Windows/Linux: Ctrl + Shift + I or F12
139
142
- macOS: ⌘ + ⌥ + I
140
143
141
144
##### Other Options
142
-
**Chrome**
145
+
146
+
**Chrome**
143
147
> Use one of the following methods:
144
148
> - click the three-dots icon in the upper-right-hand corner of the browser window `>` click More tools `>` Developer Tools
145
149
> - F12 (on Windows/Linux), and Option + ⌘ + J (on macOS)
@@ -169,13 +173,13 @@ From SwaggerHub Explore, navigate to your browser development tools, locate the
169
173
|_|
170
174
```
171
175
**Description:**
172
-
> Export SwaggerHub Explore spaces to filesystem
176
+
> Export API Hub Explore spaces to filesystem
173
177
174
178
**Usage:**
175
179
> Explore.CLI export-spaces [options]
176
180
177
181
**Options:**
178
-
> `-ec`, `--explore-cookie` <explore-cookie> (REQUIRED) A valid and active SwaggerHub Explore session cookie
182
+
> `-ec`, `--explore-cookie` <explore-cookie> (REQUIRED) A valid and active API Hub Explore session cookie
179
183
180
184
> `-fp`, `--file-path` <file-path> The path to the directory used for exporting data. It can be either relative or absolute
181
185
@@ -187,7 +191,7 @@ From SwaggerHub Explore, navigate to your browser development tools, locate the
187
191
188
192
> `-?`, `-h`, `--help` Show help and usage information
189
193
190
-
**Note** - the format for SwaggerHub Explore cookies is as follows: `"cookie-name=cookie-value; cookie-name=cookie-value"`
194
+
**Note** - the format for API Hub Explore cookies is as follows: `"cookie-name=cookie-value; cookie-name=cookie-value"`
0 commit comments