Origin

Postman is a wonderous tool for backend developers. A friend. A single point of truth. Something that stays open alongside our code editor. However, using a graphical interface in a fast-moving work environment isn't convenient and/or productive. Most of us enjoy the most productivity with our keyboard, at our Terminal. So, why not bring Postman there?

(The project is pretty much in pre-pre-release brain-storming stage. Ideas/feedbacks are welcome!)

Usage

Let's assume this Postman collection:

  ecommerce backend (collection)
  |-- user (folder)
  | |-- register (request)
  | | |-- 200
  | | `-- 400
  | |-- get
  | |-- list
  | |-- update
  | `-- remove
  `-- order
    |-- create
    |-- update
    |-- list
    |-- get
    |-- remove
    `-- checkout

show <nested resources...>

$ pcli show user register
POST /users/register

Example: 200
POST /users/register?$fields=id,fullName
body: {
  fullName: 'Muadh bin Jabal',
  userName: 'muadh1'
  country: 'Zajiratul Arab',
  password: 'password'
}
response: {
  user: {
    id: '7a96cbb8045a56d23dc1',
    fullName: 'Muadh bin Jabal'
  }
}

Example: 400
POST /users/register
body: {
  fullName: 'Muadh bin Jabal',
  userName: 'muadh1'
}
response: {
  error: {
    code: 400,
    message: 'INVALID_ARGUMENT',
    details: [
      { message: 'Required fields: country, password.', in: 'body' }
    ]

$ pcli show user update self --with-res
PUT /users/:user_id
body: { fullName: 'Muadh Bin Jabaal' }
params: { user_id: '7a96cbb8045a56d23dc1' }
query: { $fields: 'id,fullName' }
200 OK
{
  user: {
    id: 7a96cbb8045a56d23dc1
    fullName: 'Muadh Bin Jabaal'
  }
}

$ pcli edit user update self --with-res
$ pcli edit 1 3 1 --with-res
export default {
  url: { 
    method: 'PUT',
    baseURL: '/users/:user_id'
  },
  body: { fullName: 'Muadh Bin Jabaal' }
  params: { user_id: '7a96cbb8045a56d23dc1' }
  query: { $fields: 'id,fullName' }
  response: {
    code: 200,
    status: 'OK',
    body: {
      user: {
        id: 7a96cbb8045a56d23dc1
        fullName: 'Muadh Bin Jabaal'
      }
    }
  }
}

$ pcli list:edit  # id in grey, for rename, and move, recursive
- user  b6c328436a6c00b08974
  - list  f4c6c3e7e3fd8b06e15c
    - list  6972e9e4b0cfdf251c9c
    - search  f0867f6c622d6ca94f97
  - get  93316b836165aa01958c
  - update
    - self
    - admin
  - register
    - ibrahim
    - saad
    - muadh
  - remove
    - self
    - admin

$ pcli list user update
  1. self
  2. admin

$ pcli show user list search
GET /users
query: {
  sort: 'createdAt',
  fullName: 'muadh',
  page: 2,
  limit: 10,
}

$ pcli search 'list'
4. user
  1. list
5. shop
  1. list
6. order
  1. list

$ pcli run:edit user update --with-meta
PUT /users/:user_id
params: { user_id: '7a96cbb8045a56d23dc1' }
body:  {
  fullName: 'Muhammad'
  email: '[email protected]',
  identity: 'Muslim'
}

70ms 1.1KB 200 OK
{
  etag: 'W/"2e0-BhmP8Tg7Unp53FgyRTXTNA2zjFU"'
}
{
  user: {
    id: 7a96cbb8045a56d23dc1
    fullName: 'Muadh Bin Jabaal'
  }
}

$ pcli create user register
export default {
  fullName: 'Muadh bin Jabal',
  userName: 'muadh1'
  country: 'Zajiratul Arab',
  password: 'password'
}