@axway/axway-repository-cli NPM

Axway Repository CLI

Prerequisites

The Axway CLI requires Node.js 10.19.0 or newer.

Installation

$ axway pm install @axway/axway-repository-cli

Quick Start

List of the available Axway Repository commands

$ axway repo

alias for

$ axway repository

USAGE: axway repository docker <command> [options]

DOCKER COMMANDS:
  ls, list       List all available Axway Repository images
  p, pull        Pull an image from Axway Repository
  r, register    Register and authenticate Axway Repository
  s, search      Search the Axway Repository for images
  u, unregister  Unregister Axway Repository

Commands Tree

# axway repository
                ├── d, docker
                |   ├── ls, list
                |   ├── p, pull
                |   ├── r, register
                |   ├── s, search
                |   └── u, unregister
                ├── h, helm
                |   ├── ls, list
                |   ├── p, pull
                |   ├── r, register
                |   ├── s, search
                |   └── u, unregister
                └── f, file
                    ├── i, info
                    ├── ls, list
                    ├── p, pull
                    └── s, search

Commands

Axway Repository CLI covers multiple repository types

Docker

List all available Docker commands

$ axway repository docker

USAGE: axway repository docker <command> [options]

DOCKER COMMANDS:
  ls, list       List all available Axway Repository images
  p, pull        Pull an image from Axway Repository
  r, register    Register and authenticate Axway Repository
  s, search      Search the Axway Repository for images
  u, unregister  Unregister Axway Repository

Show available Docker images

$ axway repository docker ls

IMAGE                                           PRODUCT          TITLE                                DESCRIPTION

securetransport-prod/5.5/hello-world:latest     SecureTransport  Test title                           lorem ipsum

securetransport-prod/4.5.1/demo:latest          SecureTransport  Test title                           test description
securetransport-prod/4.5.1/demo1:latest         SecureTransport  1                                    1

securetransport-prod/5.5/docker_image_1:latest  SecureTransport  Secure Transport v. 5.5 -UPDATED rr  Lorem ipsum dolor sit amet, consec...
securetransport-prod/1.2/docker_image_1:latest  SecureTransport  test asdf

Pull a Docker image

$ axway repository docker pull

USAGE: axway repository docker pull [options] <IMAGE>

PULL ARGUMENTS:
  image          Docker image name

Search for Docker images

$ axway repository docker search

USAGE: axway repository docker search <TERM> [options]

SEARCH ARGUMENTS:
  term              The image name

SEARCH OPTIONS:
  --limit [value]   Max number of search results. Max is 300
  --offset [value]  Retrieving search results with offset pagination

$ axway repository docker search api

Available entries: 1

IMAGE            PRODUCT          TITLE                           DESCRIPTION
5.5/hello-world  SecureTransport  API Hello world TEST FROM CHAI abv  SecureTransport Docker sfsdf d gfd...

Helm

Helm uses a packaging format called charts. A chart is a collection of files that describe a related set of Kubernetes resources.
List all available Helm commands

$ axway repository helm

USAGE: axway repository helm <command> [options]

HELM COMMANDS:
  ls, list       List all available Axway Repository Helm charts
  p, pull        Pull an Helm Chart from Axway Repository
  r, register    Register and authenticate Axway Repository
  s, search      Search in Axway Repository
  u, unregister  Unregister Axway Repository

Show available Helm charts

$ axway repository helm ls

Available entries: 1

NAME                               CHART  PRODUCT          TITLE           DESCRIPTION
helm-securetransport-prod-grafana  6.1.4  SecureTransport  helm updated 3  helm updated

Pull a Helm Chart

$ axway repository helm pull

USAGE: axway repository helm pull [options] <CHARTNAME>

PULL ARGUMENTS:
  chartname      Helm chart name

Search for Helm charts

$ axway repository helm search

USAGE: axway repository helm search <TERM> [options]

SEARCH ARGUMENTS:
  term              The Helm Chart name

SEARCH OPTIONS:
  --limit [value]   Max number of search results. Max is 300
  --offset [value]  Retrieving search results with offset pagination

$ axway repository helm search api

Available entries: 1

NAME     PRODUCT          TITLE               DESCRIPTION
grafana  SecureTransport  API helm updated 3  helm updated

Binary

List all available file commands

$ axway repository file

USAGE: axway repository file <command> [options]

FILE COMMANDS:
  i, info        Detailed information about a file or a package
  ls, list       List all available Axway Repository files and packages
  p, pull        Download Axway Repository file or package
  s, search      Search in Axway Repository

Show available binary artifacts

$ axway repository file ls  

Entries: 10555; Limit: 30; Offset: 0  
   
ID                                    TITLE                                                              TYPE              PRODUCT               VERSION  STATUS  DATE                    
2c7948e2-9ddb-4728-ab4d-10aa5b663f1c  SecureTransport 4.9.0 (allOS) updated                              ProductExtension  SecureTransport       4.9.0    GA      2020-10-22T14:37:48.000Z
3067407d-9d38-4256-977d-876458ff6840  SecureTransport 4.9.0 (aix-power-32)                               ProductExtension  SecureTransport       4.9.0    GA      2020-10-22T14:17:52.000Z
58591dc2-3d69-47da-9350-eb04e88ca75d  AccountingIntegrator 2.2.0 (linux-x86-64)                          ProductExtension  AccountingIntegrator  2.2.0    GA      2020-10-22T11:37:50.000Z
3c3fc3a5-1df0-4927-b83f-88a85248cf96  Integrator 2.1.1 FTP Communications Connector User Guide           ProductExtension  SecureTransport       5.2.1    GA      2020-09-13T10:14:43.000Z
1dbb1383-f1e4-4a13-a657-1b60b625e9a7  Integrator 2.1.1 FTP Communications Connector User Guide           ProductExtension  SecureTransport       5.2.1    GA      2020-09-13T10:13:24.000Z

Pull a binary artifact (file)

$  axway repository file pull 5a6411f4-eb12-4fac-ab2c-e48a452c31ad

Id        5a6411f4-eb12-4fac-ab2c-e48a452c31ad
Title     SecureTransport 4.6.0 Patch5 (aix-power-32)
Filename  SecureTransport_4.6.0_Patch5_aix-power-32_BN5.md
Size      691
Status    RA
Product   SecureTransport 4.6.0
Type      Patch
Md5       561a25f4fa6590fe7c0f294d6837dd5c
Date      2020-09-08T16:09:06.000Z

Downloading : SecureTransport_4.6.0_Patch5_aix-power-32_BN5.md

Search for binary artifacts

$ axway repository file search

USAGE: axway repository file search <TERM> [options]

SEARCH ARGUMENTS:
  term              The file name

SEARCH OPTIONS:
  --limit [value]   Max number of search results. Max is 300
  --offset [value]  Retrieving search results with offset pagination

$ axway repository file search api

Entries: 2268; Limit: 30; Offset: 0

ID                                    TITLE                                                                     TYPE                  PRODUCT      VERSION  STATUS  DATE
726bf0a3-8164-43cf-8488-ba4684c70a19  APIGateway 7.3.1 VMware                                                   VMWare                API Gateway  7.3.1    GA      2014-07-31T17:20:38.000Z
9d2673ea-8679-4c21-95b4-2564410e3457  APIGateway 7.3.0 VMware                                                   VMWare                API Gateway  7.3.0    GA      2014-05-12T12:17:24.000Z
82589e86-6636-46c0-99ba-a7e0a4dfcb04  API Gateway and API Manager 7.5.3 (win-x86-32)                            Install               API Manager  7.5.3    GA      2017-04-11T17:18:18.000Z
31c55b1e-6da5-45f5-9d3a-8553f822c220  API Gateway and API Manager 7.5.3 ISO (ap-x86-64)                         Appliance             API Manager  7.5.3    GA      2017-04-20T16:46:26.000Z
ec44fbdd-b879-4b01-89b7-4991a00af57c  API Gateway and API Manager 7.5.3 Install (linux-x86-64)                  Install               API Manager  7.5.3    RA      2017-04-11T16:54:54.000Z
ef5a1b9d-2508-4c2a-b072-57305aa7894e  Api Gateway Test Download                                                 UpgradePack           API Gateway  6.3.1    GA      2018-03-12T14:37:48.000Z
c5ca5580-611b-4995-ab77-3052802f8b3a  APIGateway 7.5.2 ServicePack4 (allOS)                                     ServicePack           API Gateway  7.2.0    RA      2017-09-19T09:43:33.000Z

Legal

This project is open source under the Apache Public License v2 and is developed by Axway, Inc and the community. Please read the LICENSE file included in this distribution for more information.