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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Postman CLI
1
+
# Postman Local
2
2
3
3
A client to facilitate local development of requests, responses and scripts for Postman.
4
4
@@ -18,11 +18,11 @@ Note: due to the bundling process involved in including additional libraries, th
18
18
19
19
Node version 10.12 or higher is required.
20
20
21
-
`npm i -g @matt.ball/postman-cli`
21
+
`npm i -g postman-local`
22
22
23
23
## Configuration
24
24
25
-
Run `postman setup` within the root directory of your project to setup a Postman CLI config.
25
+
Run `postman setup` within the root directory of your project to setup a Postman Local config.
26
26
27
27
See the Postman Learning Center for [details on creating an API key](https://learning.getpostman.com/docs/postman/postman-api/intro-api/).
28
28
@@ -48,14 +48,14 @@ Converts the files created with `postman bootstrap` back to the Postman collecti
48
48
49
49
### `postman update`
50
50
51
-
Updates the original collection and any environment(s) in the Postman app with your local changes. Useful for CI/CD on merge to master - include your config/secrets `.postman.json` file (generated from `postman setup`) within this environment. _Note_: scripts in Postman will now include additional code through the Postman CLI bundling process - it's easier to edit locally only at this point.
51
+
Updates the original collection and any environment(s) in the Postman app with your local changes. Useful for CI/CD on merge to master - include your config/secrets `.postman.json` file (generated from `postman setup`) within this environment. _Note_: scripts in Postman will now include additional code through the Postman Local bundling process - it's easier to edit locally only at this point.
52
52
53
53
## Getting started
54
54
55
55
1. From the root of your repo:
56
56
`postman bootstrap`
57
57
58
-
2. Edit the files produced by the CLI.
58
+
2. Edit the files produced by Postman Local.
59
59
60
60
3. Sync the changes back to the Postman collection format:
61
61
`postman sync`
@@ -112,7 +112,7 @@ Finally, `postman bootstrap` will create a collection JSON file for your conveni
112
112
`newman run postman_collection.json -e postman_environment.json`
113
113
114
114
7. PR approved and merged, CD runs the following, updating Postman collection to Postman app:
0 commit comments