Intent.ModuleServer.Client.CLI 1.0.0-alpha.4

.NET 7.0
This is a prerelease version of Intent.ModuleServer.Client.CLI.
This package has a SemVer 2.0.0 package version: 1.0.0-alpha.4+a1b14e5f0f136af8b8886fc511e15912d7ec4946. 
dotnet tool install --global Intent.ModuleServer.Client.CLI --version 1.0.0-alpha.4
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local Intent.ModuleServer.Client.CLI --version 1.0.0-alpha.4
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=Intent.ModuleServer.Client.CLI&version=1.0.0-alpha.4&prerelease
nuke :add-package Intent.ModuleServer.Client.CLI --version 1.0.0-alpha.4

Module Server Client CLI

The Module Server Client CLI tool can be used for interacting with an Intent Architect instance to perform tasks such as uploading artifacts.

Pre-requisites

Latest Long Term Support (LTS) version of .NET.

Installation

This CLI tool is available as a .NET Tool and can be installed with the following command:

dotnet tool install Intent.ModuleServer.Client.CLI --global

[!NOTE] If dotnet tool install fails with an error to the effect of The required NuGet feed can't be accessed, perhaps because of an Internet connection problem. and it shows a private NuGet feed URL, you can try add the --ignore-failed-sources command line option (source).

You should see output to the effect of:

You can invoke the tool using the following command: module-server-client-cli
Tool 'intent.moduleserver.client.cli' (version 'x.x.x') was successfully installed.

Usage

module-server-client-cli [command] [options]

Options

Option Description
--version Show version information
-?, -h, --help Show help and usage information

Commands

Command Description
upload-module <serverUrl> <apiKey> <path> Upload a module .imod file.
upload-application-template <serverUrl> <apiKey> <path> Upload an application template .iat file.

upload-module command

Upload a module .imod file.

upload-module usage

module-server-client-cli upload-module [<serverUrl> [<apiKey> [<path>]]] [options]

upload-module arguments

Argument Description
serverUrl The module server's https address.
apiKey The API key to use to authenticate the request.
path The path of the file to upload.

upload-module options

Option Description
--force If there is already an item with the same identifier and version then this option can be used force it to be overwritten.
-?, -h, --help Show help and usage information

upload-application-template command

Upload an application template .iat file.

upload-application-template usage

module-server-client-cli upload-application-template [<serverUrl> [<apiKey> [<path>]]] [options]

upload-application-template arguments

Argument Description
serverUrl The module server's https address.
apiKey The API key to use to authenticate the request.
path The path of the file to upload.

upload-application-template options

Option Description
--force If there is already an item with the same identifier and version then this option can be used force it to be overwritten.
-?, -h, --help Show help and usage information
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.0-alpha.4 87 8/23/2023
1.0.0-alpha.3 49 8/23/2023
1.0.0-alpha.2 48 8/23/2023
1.0.0-alpha.1 53 8/23/2023
1.0.0-alpha.0 54 8/23/2023