Skip to content

Commit e321119

Browse files
committed
rename following release of official postman cli
1 parent 99d59dd commit e321119

File tree

5 files changed

+11
-10
lines changed

5 files changed

+11
-10
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ lint:
99
$(BIN)/standard
1010

1111
publish:
12-
npm publish --access public
12+
npm publish

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Postman CLI
1+
# Postman Local
22

33
A client to facilitate local development of requests, responses and scripts for Postman.
44

@@ -18,11 +18,11 @@ Note: due to the bundling process involved in including additional libraries, th
1818

1919
Node version 10.12 or higher is required.
2020

21-
`npm i -g @matt.ball/postman-cli`
21+
`npm i -g postman-local`
2222

2323
## Configuration
2424

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.
2626

2727
See the Postman Learning Center for [details on creating an API key](https://learning.getpostman.com/docs/postman/postman-api/intro-api/).
2828

@@ -48,14 +48,14 @@ Converts the files created with `postman bootstrap` back to the Postman collecti
4848

4949
### `postman update`
5050

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.
5252

5353
## Getting started
5454

5555
1. From the root of your repo:
5656
`postman bootstrap`
5757

58-
2. Edit the files produced by the CLI.
58+
2. Edit the files produced by Postman Local.
5959

6060
3. Sync the changes back to the Postman collection format:
6161
`postman sync`
@@ -112,7 +112,7 @@ Finally, `postman bootstrap` will create a collection JSON file for your conveni
112112
`newman run postman_collection.json -e postman_environment.json`
113113

114114
7. PR approved and merged, CD runs the following, updating Postman collection to Postman app:
115-
`echo ${{ secrets.postmanCli }} > .postman.json`
115+
`echo ${{ secrets.postmanLocal }} > .postman.json`
116116
`postman update`
117117

118118
## Other

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const update = require('./src/update')
99

1010
program
1111
.command('setup')
12-
.description('Configure Postman CLI for first use')
12+
.description('Configure Postman Local for first use')
1313
.action(setup)
1414

1515
program

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@matt.ball/postman-cli",
2+
"name": "postman-local",
33
"description": "A client to facilitate local development of scripts for Postman.",
44
"version": "0.1.2",
55
"license": "Apache-2.0",
@@ -10,6 +10,7 @@
1010
},
1111
"keywords": [
1212
"postman",
13+
"local",
1314
"cli",
1415
"api"
1516
],

0 commit comments

Comments
 (0)