CLI commands (Deprecated)¶
NOTICE
We recommend using IECTL publisher commands
| No. | Description | CLI Command |
|---|---|---|
| 1 | Init workspace | ie-app-publisher ws i / ie-app-publisher ws init |
| 2 | Export workspace | ie-app-publisher ws e / ie-app-publisher ws export [options] [-p, --path] < path> Export Path |
| 3 | Create app | ie-app-publisher sa c / ie-app-publisher sa create [options] [-a, --appname] < appname> Application Name [-r, --reponame] < reponame> Repository Name [-i, --iconpath] < iconpath> Icon Path [-d, --appdescription] < appdescription> Application Description Optional arguments: [-p, --appId < appId>] Unique application ID of 32 characters, if it is not provided then auto generated application ID will be used [-w, --webAddress] < webAddress> Web address for application [-s, --signUpType] < signUpType> Sign Up Type ["SignUpWithCodeOnly", "SignUpWithOrWithoutCode", "NoSignUp", "SignUpWithoutCode", "None"] [-u, --externalUrl] < externalUrl> This URL will be used by IEM app UI to open, application iframe embedded in IEM |
| 4 | List apps | ie-app-publisher sa l / ie-app-publisher sa list [options] Optional arguments: [-k, --key] < items> List of keys separated by comma. For example: "applicationId, title" |
| 5 | Export apps | ie-app-publisher sa e / ie-app-publisher sa export [options] [-a / --appname] < appname> Application Name [-p / --path] < path> Export Path |
| 6 | Import app | ie-app-publisher sa i / ie-app-publisher sa import [options] [-a / --apptarpath] < apptarpath> Path of the tar or .app file |
| 7 | Create app version | ie-app-publisher sa cv / ie-app-publisher sa createversion [options] [-a / --appname] < appname> Application Name [-v / --versionnumber] < versionnumber> Version Number refers to versioning [-y, --yamlpath] < yamlpath> Path of docker compose yaml or folder path in case of kubernetes application Optional arguments: [-j, --imagetarjson] < imagetarjson> List of services with the reference to their exported docker images [-n, --nginxjson] < nginxjson> JSON map of nginx configuration [-c/ --changelogs] < changelogs> Release Notes [-m/ --defaultmountpath] To add default mount path (./publish/ and ./cfg-data/) [-s, --redirectsection] < redirectsection> Redirect Section [-t, --redirecttype] < redirecttype> Redirect Type ("FromBoxReverseProxy","FromBoxSpecificPort"," ExternalLink") [-u, --redirecturl] < redirecturl> Redirect URL [-r, --restredirecturl] < restredirecturl> Rest Redirect URL [-e, --eventservice] < eventservice> Event Service is a feature provided by edge runtime for applications to receive and publish events. The communication is based on Unix Domain Socket(UDS). For example: --eventservice "{"servicename":"/opt/event.sock"}" [-o, --authservice] < authservice> Auth service enables an application to use IED auth service api's(Make sure the application is created by enabling checkmark - Use Edge Device Auth Service). For example: --authservice "{"servicename":"/opt/appsecrets.json"}" [-x, --accesswithoutlogin] Allow application access without login (Not applicable for industrial edge devices) [--arch] < arch> Application supported platform, value can be x86-64 or arm64. By default it is set to x86-64 (default: "x86-64") [-d, --devicefeatures] < devicefeatures> The Applications will be allowed to trigger a Shutdown Operation, on the supporting device. The Device will gracefully shutdown in case triggered, by releasing the resources to avoid damaging integrity of the system. Especially useful for electric outage detection applications to trigger a shutdown in case of an outage [-b, --adddiscoveryinfo] < adddiscoveryinfo> Add service metadata (discovery information) |
| 8 | List app versions | ie-app-publisher sa lv / ie-app-publisher sa listversions [options] [-a / --appname]< appname> Application Name Optional arguments: [-k, --key] < items> List of keys separated by comma. For example: "versionNumber, versionId" |
| 9 | Export app version | ie-app-publisher sa ev / ie-app-publisher sa exportversion [options] [-a / --appname] < appname> Application Name [-v / --versionnumber] < versionnumber> Version Number [-e / --exportpath] < exportpath> Export Path Optional arguments: [-k / --privatekeypath] < value> Private Key File Path (deprecated) [-s / --redirectsection] < redirectsection> Redirect Section [-t / --redirecttype] < redirecttype> Redirect Type ("FromBoxReverseProxy", "FromBoxSpecificPort","ExternalLink") [-u / --redirecturl] < redirecturl> Redirect URL [-r / --restredirecturl] < restredirecturl> Rest Redirect URL [-x/ --accesswithoutlogin] Allow application access without login (Not applicable for industrial edge devices) |
| 10 | Delete app | ie-app-publisher sa d / ie-app-publisher sa delete [options] [-a / --appname] < appname> Application Name Optional arguments: [-y/ --yes] Delete Without Prompt |
| 11 | Delete app version | ie-app-publisher sa dv / ie-app-publisher sa deleteversion [options] [-a / --appname] < appname> Application Name [-v / --versionnumber] < versionnumber> Version Number Optional arguments: [-y/ --yes] Delete Without Prompt |
| 12 | Set Docker engine | ie-app-publisher de c / ie-app-publisher de connect [options] [-u / --url] < url> Docker Engine URL Optional arguments: [-f / --cafile] [value] CA [-c / --certfile] [value] Certificate [-k / --keyfile] [value] Key |
| 13 | Create and export app | ie-app-publisher sa cae / ie-app-publisher sa createAndExport [-a / --appname] < appname> Application Name [-v / --versionnumber] < versionnumber> Version Number [-e / --exportpath] < exportpath> Export path Optional arguments: [-j, --imagetarjson] < imagetarjson> List of services with the reference to their exported docker images [-n, --nginxjson] < nginxjson> JSON map of nginx configuration [-r / --reponame] < reponame> Repository Name [-i / --iconpath] < iconpath> Icon Path [-y / --yamlpath] < yamlpath> Path of docker compose yaml or folder path in case of kubernetes application [-k / --privatekeypath] < value> Private Key File Path (deprecated) [-s / --redirectsection] < redirectsection> Redirect Section [-t / --redirecttype] < redirecttype> Redirect Type ["FromBoxReverseProxy","FromBoxSpecificPort","ExternalLink"] [-u / --redirecturl] < redirecturl> Redirect URL [-d / --restredirecturl] < restredirecturl> Rest Redirect URL [-m/ --defaultmountpath] To add default mount path (./publish/ and ./cfg-data/) [-x/ --accesswithoutlogin] Allow application access without login (Not applicable for industrial edge devices) [-o / --appdescription] < appdescription> App Description [-c/ --changelogs] < changelogs> Release Notes [-f, --eventservice] < eventservice> Event Service is a feature provided by edge runtime for applications to receive and publish events. The communication is based on Unix Domain Socket(UDS). For example: --eventservice "{"servicename":"/opt/event.sock"}" [-g, --authservice] < authservice> Auth service enables an application to use IED auth service api's(Make sure the application is created by enabling checkmark - Use Edge Device Auth Service). For example: --authservice "{"servicename":"/opt/appsecrets.json"}" [-p, --appId] < appId> Unique application ID of 32 characters, if it is not provided then auto generated application ID will be used [-b, --webAddress] < webAddress> Web address for application [-l, --signUpType] < signUpType> Sign Up Type ["SignUpWithCodeOnly", "SignUpWithOrWithoutCode", "NoSignUp", "SignUpWithoutCode", "None"] [-z, --externalUrl] < externalUrl> This URL will be used by IEM app UI to open, application iframe embedded in IEM [--arch] < arch> Application supported platform, value can be x86-64 or arm64.By default it is set to "x86-64" (default: "x86-64") [-q, --devicefeatures] < devicefeatures> The Applications will be allowed to trigger a Shutdown Operation, on the supporting device. The Device will gracefully shutdown in case triggered, by releasing the resources to avoid damaging integrity of the system. Especially useful for electric outage detection applications to trigger a shutdown in case of an outage [-w, --adddiscoveryinfo] < adddiscoveryinfo> Add service metadata (discovery information) |
| 14 | Disconnect Docker engine | ie-app-publisher de d / ie-app-publisher de disconnect |
| 15 | Check CLI version | ie-app-publisher -V / ie-app-publisher --Version |
| 16 | Show Help | ie-app-publisher –h / ie-app-publisher --help |
| 17 | Portal logout | ie-app-publisher em lo / ie-app-publisher em logout |
| 18 | Portal login | ie-app-publisher em li / ie-app-publisher em login [options] [ -u, --portalurl] < portalurl> Url of Edge Management on which you want to create application version [ -e, --email] < email> Email address used for login [ -p, --password] < password> Password used for login |
| 19 | List projects | ie-app-publisher em pr l / ie-app-publisher em project list [options] Optional arguments: [-k, --key] < items> List of keys separated by comma. For example: "projectId, name" |
| 20 | List apps in project | ie-app-publisher em pr la / ie-app-publisher em project listapps [options] [-p, --projectId] < projectId> Unique ID of Project of which you want to list applications Optional arguments: [-k, --key] < items> List of keys separated by comma. For example: "applicationId, title" |
| 21 | List app details | ie-app-publisher em app dt / ie-app-publisher em application detail [options] [ -a, --appId] < appId> Unique ID of an application Optional arguments: [ -p, --private] If application is not published to catalog [-k, --key] < items> List of keys separated by comma. For example: "title, applicationId, appVersions" |
| 22 | Create backend managed app version | ie-app-publisher em app cuv / ie-app-publisher em application createunpublishedversion [options] [-a, --appid] < appid> Application unique ID for which the version has to be created [-v, --versionnumber] < versionnumber> Version Number refers to versioning [-y, --yamlpath] < yamlpath> Path of docker compose yaml or folder path in case of kubernetes application Optional arguments: [-i, --imagetagjson] < imagetagjson> JSON map of service name and tag of image. Only for kubernetes applications [-n, --nginxjson] < nginxjson> JSON map of nginx configuration [-c, --changelogs] < changelogs> Release Notes [-m, --defaultmountpath] To add default mount path (./publish/ and ./cfg-data/) [-s, --redirectsection < redirectsection>] Redirect Section [-t, --redirecttype] < redirecttype> Redirect Type ["FromBoxReverseProxy","FromBoxSpecificPort","ExternalLink"] [-u, --redirecturl] < redirecturl> Redirect URL [-r, --restredirecturl] < restredirecturl> Rest Redirect URL [-e, --eventservice] < eventservice> Event Service is a feature provided by edge runtime for applications to receive and publish events. The communication is based on Unix Domain Socket(UDS). For example: --eventservice "{"servicename":"/opt/event.sock"}" [-o, --authservice] < authservice> Auth service enables an application to use IED auth service api's(Make sure the application is created by enabling checkmark - Use Edge Device Auth Service). For example: --authservice "{"servicename":"/opt/appsecrets.json"}" [-j, --imagetarjson] < imagetarjson> List of services with the reference to their exported docker images. [-x, --accesswithoutlogin] Allow application access without login (Not applicable for industrial edge devices) [--arch] < arch> Application supported platform, value can be x86-64 or arm64.By default it is set to x86-64 (default: "x86-64") [-d, --devicefeatures] < devicefeatures> The Applications will be allowed to trigger a Shutdown Operation, on the supporting device. The Device will gracefully shutdown in case triggered, by releasing the resources to avoid damaging integrity of the system. Especially useful for electric outage detection applications to trigger a shutdown in case of an outage [-b, --adddiscoveryinfo] < adddiscoveryinfo> Add service metadata (discovery information) |
| 23 | Export backend managed app version | ie-app-publisher em app epv / ie-app-publisher em application exportpublishedversion [options] [-a, --appid] < appid> Application unique ID for which the version has to be created [-v, --versionnumber] < versionnumber> Version Number refers to versioning [-e, --exportpath] < exportpath> Export path Optional arguments: [-k / --privatekeypath] < value> Private Key Path (deprecated) Note: Not applicable for apps in the catalog |
| 24 | Import standalone app version | ie-app-publisher em app isav / ie-app-publisher em application importstandaloneversion [options] [-a, --applicationname] < applicationname> Name of the stand-alone application [-v, --versionnumber] < versionnumber> Version number which you want to import to Edge Management Optional arguments: [-w, --webaddress] < webaddress> Web address for application. Mandatory if not provided while creating application [-g, --signuptype] < signuptype> Signup type of an application ["SignUpWithOrWithoutCode", SignUpWithCodeOnly", "NoSignUp", "SignUpWithoutCode", "None"] [-c, --categoryid] < categoryid> Unique id of category available on Edge Management under which you want to add this application. Mandatory for importing the version for the first time [-p, --projectid] < projectid> Unique id of projects available on Edge Management under which you want to add this application. Mandatory for importing the version for the first time [-l, --changelogs] < changelogs> Release Notes |
| 25 | Delete backend managed app version/td> | ie-app-publisher em app dpv / ie-app-publisher em application deletepublishedversion [options] [-a, --appid] < appid> Application unique ID for which the version has to be deleted [-v, --versionnumber] < versionnumber> Version Number Optional arguments: [-y, --yes] Delete Without Prompt Note: Cannot be used for apps in the catalog< |
| 26 | List unpublished app version | ie-app-publisher em app luv / ie-app-publisher em application listunpublishedversion [options] [-a, --appid] < appid> Application unique ID |
| 27 | Delete unpublished app version | ie-app-publisher em app duv / ie-app-publisher em application deleteunpublishedversion [options] [-a, --appid] < appid> Application unique ID |
| 28 | Upload unpublished app version | ie-app-publisher em app uuv / ie-app-publisher em application uploadunpublishedversion [options] [-a, --appid] < appid> Application unique ID [-v, --versionnumber] < versionnumber> Version Number which you want to upload |
| 29 | Upload document link of app version | ie-app-publisher em app ldpv / ie-app-publisher em application linkdocumenttopublishedversion [options] [-a, --appid] < appid> Application unique ID [-v, --versionid] < versionid> Version unique ID [-s, --srclink] < srclink> Source link of an application [-d, --doclink] < doclink> Document link of an application Note: Not applicable for apps in the catalog |
| 30 | Validate *.app file | ie-app-publisher sa val / ie-app-publisher standalone validate [options] [-p, --path] < path> App file path [-k, --public-key < public-key>] Path to the public key to validate the signature of the app (deprecated) [-n, --networks] < networks> Json of service name and list of network names the application is dependent on. Example: Given service name my-app has depenedency to networks one and two:'{"my-app":["one","two"]}' [-a, --auth-service] < auth-service> List of service names seperated by commas for which it need to validate the dependency to the auth service [-e, --event-service] < event-service> List of service names seperated by commas for which it need to validate the dependency to the event service [-i, --ignore-errors] Ignores errors and continues the validation. DANGER: This will not return a failing exit code! [-s, --skip] < skip> List of validation steps that shall be skipped separated by commas. Allowed Values: [validate_app_file_schema, validate_digest, validate_signature, validate_yaml_schema, validate_ie_rules, validate_meta_files, validate_docker_images] |
| 31 | Add app configuration | ie-app-publisher em app ac / ie-app-publisher em app addconfiguration [options] [-a, --appid < appid>] Application unique ID [-n, --configname < configname>] Configuration Name [-d, --configdescription < configdescription>] Configuration Description [-p, --hostpath < hostpath>] Mounted volume path that is configured in the "*.yaml" configuration file of the app. Optional arguments: [-s, --subpath < subpath>] Relative path to the host path [-x, --secure] To secure configuration [-v, --versioned] To add configurations with multiple versions. Note: --templatename, --templatedescription and --filepath arguments will be ignored with this option. [-r, --versionname < versionname>] Version Name [-i, --versiondescription < versiondescription>] Version Description [-t, --templatename < templatename>] Template Name [-e, --templatedescription < templatedescription>] Template Description [-j, --jsonschema] Json Schema for Template type configuration. Note: --Using JSON based App Configuration Services will require configuration changes for the following application [-f, --filepath < filepath>] File path, for Version type and Template type configurations |
| 32 | Add app configuration "Versioned" | ie-app-publisher em app acv / ie-app-publisher em app addconfigurationversion [options] [-a, --appid < appid>] Application unique ID [-c, --configurationid < configurationid>] Application configuration ID [-v, --versionname < versionname>] Version Name [-d, --versiondescription < versiondescription>] Version Description [-f, --filepath < filepath>] File Path |
| 33 | Delete app configuration | ie-app-publisher em app dc / ie-app-publisher em app deleteconfiguration [options] [-a, --appid < appid>] Application unique ID [-c, --configid < configid>] Application config ID Optional Arguments: [-y, --yes] Delete Without Prompt |
| 34 | List configurations | ie-app-publisher em app lac / ie-app-publisher em app listConfigurationsofApplication [options] [-a, --appid < appid>] Unique ID of an application Optional Arguments: [-k, --key < items>] List of keys separated by comma. For example: "appConfigId, displayName" |
| 35 | Delete configuration version | ie-app-publisher em app dcv / ie-app-publisher em app deleteConfigurationVersion [options] [-a, --appid < appid>] Application unique ID [-c, --configid < configid>] Application config ID [-v, --appconfigversionid < appconfigversionid>] App configuration version ID Optional Arguments: [-y, --yes] Delete Without Prompt |
| 36 | List all categories | ie-app-publisher em lc / ie-app-publisher em listcategories [options] Optional Arguments: [-k, --key < items>] List of keys seperated by comma. For example: "categoryId, name" |
| 37 | Show IE Publisher CLI specific environment variables | ie-app-publisher env / ie-app-publisher environment |
| 38 | Add configuration of standalone application | ie-app-publisher sa ac / ie-app-publisher sa addconfiguration [options] [-a, --appname < appname>] Application Name [-n, --configname < configname>] Configuration Name [-d, --configdescription < configdescription>] Configuration Description [-p, --hostpath < hostpath>] Mounted volume path that is configured in the "*.yaml" configuration file of the app. Optional arguments: [-s, --subpath < subpath>] Relative path to the host path [-x, --secure] To secure configuration [-v, --versioned] To add configurations with multiple versions. Note: --templatename, --templatedescription and --filepath arguments will be ignored with this option [-r, --versionname < versionname>] Version Name [-i, --versiondescription < versiondescription>] Version Description [-t, --templatename < templatename>] Template Name [-e, --templatedescription < templatedescription>] Template Description [-j, --jsonschema] Json Schema for Template type configuration. Note: --Using JSON based App Configuration Services will require configuration changes for the following application. [-f, --filepath < filepath>] File Path, for Browse type and Template type configurations |
| 39 | Add version of already added configurations of type versioned in Standalone application | ie-app-publisher sa acv / ie-app-publisher sa addconfigurationversion [options] [-a, --appname < appname>] Application unique name [-c, --configurationid < configurationid>] Application configuration ID [-v, --versionname < versionname>] Version Name [-d, --versiondescription < versiondescription>] Version Description [-f, --filepath < filepath>] File Path |
| 40 | List configurations added in standalone application | ie-app-publisher sa lac / ie-app-publisher sa listConfigurationsofApplication [options] [-a, --appname < appname>] Application Name Optional Arguments: -[-k, --key < items>] List of keys separated by comma. For Example: "appConfigId,displayName" |
| 41 | Delete configuration of standalone application | ie-app-publisher sa dc / ie-app-publisher sa deleteconfiguration [options] [-a, --appname < appname>] Application Name [-c, --configid < configid>] Application config ID Optional Arguments: -[-y, --yes] Delete Without Prompt |
| 42 | Delete configuration version of standalone application | ie-app-publisher sa dcv / ie-app-publisher sa deleteConfigurationVersion [options] [-a, --appname < appname>] Application Name [-c, --configid < configid>] Application configuration ID [-v, --appconfigversionid < appconfigversionid>] Application configuration version ID Optional Arguments: -[-y, --yes] Delete Without Prompt |
| 43 | Import application to catalog | ie-app-publisher em app uc / ie-app-publisher em app uploadtocatalog [options] [-a, --appname < appname>] Application Name [-v, --versionnumber < versionnumber>] Version Number refers to versioning [-f, --filepath < filepath>] Path of app file to upload |
| 44 | IE Hub - Login | ie-app-publisher ih li / ie-app-publisher ih login [options] [-u, --url < url>] URL of IEHUB on which you want to perform operations [-e, --email < email>] Email address used for login [-p, --password < password>] Password used for login |
| 45 | IE Hub - Logout | ie-app-publisher ih lo / ie-app-publisher ih logout |
| 46 | IE Hub - List all versions of an application | ie-app-publisher ih app lv / ie-app-publisher ih application listversion [options] [-a, --appname < appname>] Application Name Optional Arguments: [-k, --key < items>] List of keys separated by comma. For example: "categoryId, name" |
| 47 | IE Hub - Create version of an application | ie-app-publisher ih app cv / ie-app-publisher ih application createversion [options] [-a, --appname < appname>] Application Name [-v, --versionnumber < versionnumber>] Version Number refers to versioning Optional Arguments: [-b, --appbinary < appbinary>] App file of the application version to upload [-o, --ossfile < ossfile>] OSS file associated with application version to upload. Supported formats: *.7z, *.zip [-n, --releasenotes < releasenotes>] Release notes file associated with application version to upload. Supported formats: *.txt, *.pdf, *.7z, *.zip |
| 48 | IE Hub - Get version detail | ie-app-publisher ih app vd / ie-app-publisher ih application versiondetail [options] [-a, --appname < appname>] Application Name [-v, --versionnumber < versionnumber>] Version Number refers to versioning Optional Arguments: [-k, --key < items>] List of keys separated by comma. For example: "version, status" |
| 49 | IE Hub - Activate app version | ie-app-publisher ih app av / ie-app-publisher ih application activateversion [options] [-a, --appname < appname>] Application Name [-v, --versionnumber < versionnumber>] Version Number refers to versioning |
| 50 | IE Hub - Release app version | ie-app-publisher ih app rv / ie-app-publisher ih application releaseversion [options] [-a, --appname < appname>] Application Name [-v, --versionnumber < versionnumber>] Version Number refers to versioning |
| 51 | IE Hub - Delete app version | ie-app-publisher ih app dv / ie-app-publisher ih application deleteversion [options] [-a, --appname < appname>] Application Name [-v, --versionnumber < versionnumber>] Version Number refers to versioning Optional arguments: [-y, --yes] Delete Without Prompt |
| 52 | Download logs | ie-app-publisher l / ie-app-publisher downloadLogs [-p, --path < path>] Download Path |
Global flag "--verbose" or "--Verbose"¶
Use the "--verbose" or "--Verbose" argument with any CLI command to show a detailed output or additional details of that command, for example:
ie-app-publisher em app cuv --verbose
or
ie-app-publisher em app cuv –Verbose
Creating the same app¶
To ensure that you are always creating the same app, use the same appid.
First, create an app with a 32 character long appid. Then use the following command, for example, to ensure that you are always creating the same app:
To create the same app, ensure that you are using always the same argument values.
Antivirus software on Windows¶
If you are using the CLI on Windows, your antivirus software may treat the "ie-publisher-win.exe" file as threat. To use the CLI on Windows, add the "ie-publisher-win.exe" file in your antivirus software exclusions.