Nemo's Parental Misguidance
    Have ideas to improve npm?Join in the discussion! »

    @redvanworkshop/autobahn-cli

    1.4.2 • Public • Published

    Logo

    Autobahn-CLI

    A command line suite for performing autobahn related tasks with ease

    Introduction

    This tool originally was designed to handle cartridge specific data imports to SFCC instances. Our main product is titled Autobahn, hence Autobahn-CLI. Since, it has evolved into a universal data management/import tool for any SFCC instance. By simply creating a top level folder in your project called data, you can organize metadata based on specific cartridge intrgrations, and import data on demand. This tool wraps the popular sfcc-ci library, and just extends on its functionality to provide the developer with a more granular control over data management.

    • [x] Import instance meta/site data

    Developer Overview

    Commands

    Install

    npm install

    npm install -g @redvanworkshop/autobahn-cli
    autobahn --help

    Setup

    Configuration

    data example

    Data-1

    Data folders should be structured as "Site Import" archives Data-2

    dw.json

    For sandbox setup:

    {
      "hostname": "",
      "username": "",
      "password": "",
      "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "clientSecret": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "dataFinal": "data_final"
    }

    Open Commerce API Settings (data)

    {
       "_v":"19.5",
       "clients":[
          {
             "client_id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
             "resources":[
                {
                   "resource_id":"/code_versions/*",
                   "methods":[
                      "patch",
                      "delete"
                   ],
                   "read_attributes":"(**)",
                   "write_attributes":"(**)"
                },
                {
                   "resource_id":"/jobs/*/executions",
                   "methods":[
                      "post"
                   ],
                   "read_attributes":"(**)",
                   "write_attributes":"(**)"
                },
                {
                   "resource_id":"/jobs/*/executions/*",
                   "methods":[
                      "get"
                   ],
                   "read_attributes":"(**)",
                   "write_attributes":"(**)"
                },
                {
                   "resource_id":"/sites/*/cartridges",
                   "methods":[
                      "post"
                   ],
                   "read_attributes":"(**)",
                   "write_attributes":"(**)"
                }
             ]
          }
       ]
    }

    WebDAV Client Permissions

    {
       "clients":[
          {
             "client_id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
             "permissions":[
                {
                   "path":"/impex",
                   "operations":[
                      "read_write"
                   ]
                },
                {
                   "path":"/cartridges",
                   "operations":[
                      "read_write"
                   ]
                },
                {
                   "path":"/static",
                   "operations":[
                      "read_write"
                   ]
                },
                {
                   "path":"/catalogs/<your-catalog-id>",
                   "operations":[
                      "read_write"
                   ]
                },
                {
                   "path":"/libraries/<your-library-id>",
                   "operations":[
                      "read_write"
                   ]
                },
                {
                   "path":"/dynamic/<your-site-id>",
                   "operations":[
                      "read_write"
                   ]
                }
             ]
          }
       ]
    }

    Contributing

    git clone

    cd ~
    git clone https://github.com/redvanworkshop/autobahn-cli.git
    cd autobahn-cli
    npm install -g .
    autobahn-cli --help

    Keywords

    none

    Install

    npm i @redvanworkshop/autobahn-cli

    DownloadsWeekly Downloads

    87

    Version

    1.4.2

    License

    ISC

    Unpacked Size

    89.1 kB

    Total Files

    18

    Last publish

    Collaborators

    • avatar
    • avatar