Intent.SoftwareFactory.CLI 4.2.6

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global Intent.SoftwareFactory.CLI --version 4.2.6                
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.SoftwareFactory.CLI --version 4.2.6                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Intent.SoftwareFactory.CLI&version=4.2.6                
nuke :add-package Intent.SoftwareFactory.CLI --version 4.2.6                

Software Factory CLI

A CLI (command line interface) version of the Intent Architect Software Factory.

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.SoftwareFactory.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: intent-cli
Tool 'intent.softwarefactory.cli' (version 'x.x.x') was successfully installed.

Usage

intent-cli [command] [options]

Options

Option Description
--version Show version information
-?, -h, --help Show help and usage information
--error-logging-command <error-logging-command> Command to use for logging an error. Some continuous integration environments watch output for "commands" for logging of errors. Will be automatically configured when the process is detected to be running on the following kinds of build servers:<br />- Azure Pipelines<br /><br />See the documentation on Serilog.Expressions ExpressionTemplate for formatting options: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate
--warning-logging-command <warning-logging-command> Command to use for logging a warning. Some continuous integration environments watch output for "commands" for logging of errors. Will be automatically configured when the process is detected to be running on the following kinds of build servers:<br />- Azure Pipelines<br /><br />See the documentation on Serilog.Expressions ExpressionTemplate for formatting options: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate

Commands

Command Description
ensure-no-outstanding-changes <username> <password> <isln-path> Runs the Software Factory and if there are any outstanding changes it prints out an error and exits with a non-zero return code.

ensure-no-outstanding-changes command

Runs the Software Factory and if there are any outstanding changes it prints out an error and exits with a non-zero return code.

ensure-no-outstanding-changes usage

intent-cli ensure-no-outstanding-changes <username> <password> <isln-path> [options]

ensure-no-outstanding-changes arguments

Argument Description
<username> Username for an active Intent Architect account.
<password> Password for the Intent Architect account.
<isln-path> Path to the Intent Architect solution (.isln) file or folder containing a single .isln file.

ensure-no-outstanding-changes options

Option Description
--application-id <application-id> The Id of the Intent Architect application. If unspecified then all applications found in the .isln will be run.
--attach-debugger The Software Factory will pause at startup giving you chance to attach a .NET debugger.
-?, -h, --help Show help and usage information
--error-logging-command <error-logging-command> Command to use for logging an error. Some continuous integration environments watch output for "commands" for logging of errors. Will be automatically configured when the process is detected to be running on the following kinds of build servers:<br />- Azure Pipelines<br /><br />See the documentation on Serilog.Expressions ExpressionTemplate for formatting options: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate
--warning-logging-command <warning-logging-command> Command to use for logging a warning. Some continuous integration environments watch output for "commands" for logging of errors. Will be automatically configured when the process is detected to be running on the following kinds of build servers:<br />- Azure Pipelines<br /><br />See the documentation on Serilog.Expressions ExpressionTemplate for formatting options: https://github.com/serilog/serilog-expressions#formatting-with-expressiontemplate

Example: Azure Pipelines

[!TIP] Install the Intent.ContinuousIntegration.AzurePipelines module into your Intent Architect application to have it automatically generate an azure-pipelines.yml file for you, refer its readme for more information.

Create a variable group with the Intent Architect account details

Create a variable group with the Intent Architect account details, for example:

Variable group with Intent Architect account details

Variable groups are defined globally for an Azure DevOps project, to be able to access a variable group for a particular pipeline, it needs to be linked to it.

Add the variable group and other variables to the pipeline YAML file

To make the variable group available to a stage within your pipeline, it will need to be added to its variables. You may also want to define variables for the other command line arguments and options:

variables:
- group: 'Intent Architect Credentials'
- name: 'intentSolutionPath'
  value: 'intent'

Create a step to install the CLI

- task: PowerShell@2
  displayName: 'Install Intent Architect Software Factory CLI'
  inputs:
    targetType: 'inline'
    pwsh: true
    script: 'dotnet tool install Intent.SoftwareFactory.CLI --global'

Create a step to run the CLI

- task: PowerShell@2
  displayName: 'run intent cli'
  env:
    INTENT_USER: $(intent-architect-user)
    INTENT_PASS: $(intent-architect-password)
    INTENT_SOLUTION_PATH: $(intentSolutionPath)
  inputs:
    targetType: 'inline'
    pwsh: true
    script: |
      intent-cli ensure-no-outstanding-changes "$Env:INTENT_USER" "$Env:INTENT_PASS" "$Env:INTENT_SOLUTION_PATH"

A complete YAML file

trigger:
  batch: 'true'
  branches:
    include:
    - '*'

pool:
  vmImage: 'ubuntu-latest'

variables:
- group: 'Intent Architect Credentials'
- name: 'intentSolutionPath'
  value: 'intent'

steps:

- task: PowerShell@2
  displayName: 'Install Intent Architect Software Factory CLI'
  inputs:
    targetType: 'inline'
    pwsh: true
    script: 'dotnet tool install Intent.SoftwareFactory.CLI --global'

- task: PowerShell@2
  displayName: 'run intent cli'
  env:
    INTENT_USER: $(intent-architect-user)
    INTENT_PASS: $(intent-architect-password)
    INTENT_SOLUTION_PATH: $(intentSolutionPath)
  inputs:
    targetType: 'inline'
    pwsh: true
    script: |
      intent-cli ensure-no-outstanding-changes "$Env:INTENT_USER" "$Env:INTENT_PASS" "$Env:INTENT_SOLUTION_PATH"

Run the pipeline

When you run the pipeline, it should now install the CLI and run it.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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
4.3.6 72 11/14/2024
4.3.6-pre.2 48 11/13/2024
4.3.6-pre.1 102 11/7/2024
4.3.6-pre.0 31 11/7/2024
4.3.5 146 11/7/2024
4.3.5-pre.2 102 11/1/2024
4.3.5-pre.1 94 10/28/2024
4.3.5-pre.0 121 10/22/2024
4.3.4 219 10/21/2024
4.3.4-pre.4 49 10/21/2024
4.3.4-pre.2 102 10/14/2024
4.3.4-pre.1 51 10/14/2024
4.3.4-pre.0 67 10/13/2024
4.3.3 172 10/11/2024
4.3.3-pre.2 61 10/11/2024
4.3.3-pre.1 46 10/10/2024
4.3.3-pre.0 43 10/10/2024
4.3.2 120 10/10/2024
4.3.2-pre.0 71 10/9/2024
4.3.1 251 10/2/2024
4.3.1-pre.1 45 10/2/2024
4.3.1-pre.0 55 10/1/2024
4.3.0 150 9/29/2024
4.3.0-beta.10 132 9/23/2024
4.3.0-beta.8 221 9/14/2024
4.3.0-beta.6 75 9/12/2024
4.3.0-beta.0 499 8/6/2024
4.2.10-alpha.0 66 8/21/2024
4.2.9 716 7/15/2024
4.2.9-pre.1 81 7/10/2024
4.2.9-pre.0 119 7/2/2024
4.2.8 269 6/30/2024
4.2.8-pre.1 118 6/24/2024
4.2.8-pre.0 89 6/21/2024
4.2.7 189 6/19/2024
4.2.7-pre.0 90 6/13/2024
4.2.6 369 5/22/2024
4.2.6-pre.0 81 5/21/2024
4.2.5 137 5/21/2024
4.2.5-pre.8 80 5/20/2024
4.2.5-pre.7 52 5/20/2024
4.2.5-pre.6 59 5/20/2024
4.2.5-pre.5 83 5/14/2024
4.2.5-pre.4 77 5/13/2024
4.2.5-pre.3 60 5/11/2024
4.2.5-pre.2 99 5/7/2024
4.2.5-pre.1 60 5/2/2024
4.2.5-pre.0 91 4/29/2024
4.2.4 467 4/12/2024
4.2.4-pre.1 110 4/7/2024
4.2.4-pre.0 65 4/5/2024
4.2.4-beta.6 49 4/5/2024
4.2.4-beta.5 80 4/4/2024
4.2.4-beta.4 104 4/2/2024
4.2.4-beta.3 64 4/2/2024
4.2.4-beta.2 84 4/1/2024
4.2.4-beta.1 74 3/27/2024
4.2.4-beta.0 112 3/26/2024
4.2.3 272 3/25/2024
4.2.3-pre.0 169 3/19/2024
4.2.2 263 3/12/2024
4.2.2-pre.0 67 3/11/2024
4.2.1 162 3/11/2024
4.2.1-pre.0 68 3/11/2024
4.2.0 169 3/10/2024
4.2.0-beta.8 70 3/8/2024
4.2.0-beta.7 63 3/8/2024
4.2.0-beta.6 130 3/5/2024
4.2.0-beta.5 74 3/5/2024
4.2.0-beta.4 96 2/29/2024
4.2.0-beta.3 358 2/14/2024
4.2.0-beta.2 59 2/14/2024
4.2.0-beta.1 80 2/14/2024
4.2.0-beta.0 151 2/9/2024
4.1.5 494 1/23/2024
4.1.5-pre.2 79 1/22/2024
4.1.5-pre.1 75 1/21/2024
4.1.5-pre.0 67 1/20/2024
4.1.4 336 1/17/2024
4.1.4-pre.0 82 1/16/2024
4.1.3 315 1/14/2024
4.1.3-pre.4 73 1/13/2024
4.1.3-pre.3 70 1/13/2024
4.1.3-pre.2 93 1/12/2024
4.1.3-pre.1 136 1/10/2024
4.1.3-pre.0 67 1/10/2024
4.1.2 372 1/8/2024
4.1.2-pre.6 118 1/6/2024
4.1.2-pre.5 87 1/5/2024
4.1.2-pre.4 89 1/5/2024
4.1.2-pre.3 100 1/3/2024
4.1.2-pre.2 88 1/2/2024
4.1.2-pre.1 107 12/31/2023
4.1.2-pre.0 86 12/28/2023
4.1.1 149 12/22/2023
4.1.1-pre.2 51 12/22/2023
4.1.1-pre.1 71 12/22/2023
4.1.1-pre.0 51 12/22/2023
4.1.0 114 12/20/2023
4.1.0-beta.21 275 12/10/2023
4.1.0-beta.20 181 12/6/2023
4.1.0-beta.19 55 12/5/2023
4.1.0-beta.18 85 12/4/2023
4.1.0-beta.17 77 12/2/2023
4.1.0-beta.16 93 11/30/2023
4.1.0-beta.15 61 11/29/2023
4.1.0-beta.14 86 11/28/2023
4.1.0-beta.12 123 11/24/2023
4.1.0-beta.11 129 11/22/2023
4.1.0-beta.10 108 11/19/2023
4.1.0-beta.9 118 11/15/2023
4.1.0-beta.8 151 11/7/2023
4.1.0-beta.7 102 11/6/2023
4.1.0-beta.6 67 11/3/2023
4.1.0-beta.5 73 11/3/2023
4.1.0-beta.4 85 11/2/2023
4.1.0-beta.3 82 11/2/2023
4.1.0-beta.2 165 10/29/2023
4.1.0-beta.1 63 10/28/2023
4.1.0-beta.0 134 10/25/2023
4.1.0-alpha.202312081616 57 12/8/2023
4.1.0-alpha.202312062101 53 12/7/2023
4.1.0-alpha.32 93 10/25/2023
4.1.0-alpha.31 64 10/24/2023
4.1.0-alpha.30 97 10/24/2023
4.1.0-alpha.29 61 10/23/2023
4.1.0-alpha.28 108 10/22/2023
4.1.0-alpha.27 120 10/17/2023
4.1.0-alpha.26 116 10/14/2023
4.1.0-alpha.25 88 10/12/2023
4.1.0-alpha.24 124 10/9/2023
4.1.0-alpha.23 82 10/8/2023
4.1.0-alpha.21 180 10/1/2023
4.1.0-alpha.20 76 9/30/2023
4.1.0-alpha.19 79 9/29/2023
4.1.0-alpha.17 105 9/28/2023
4.1.0-alpha.16 144 9/25/2023
4.1.0-alpha.15 83 9/24/2023
4.1.0-alpha.14 75 9/24/2023
4.1.0-alpha.13 81 9/23/2023
4.1.0-alpha.12 130 9/19/2023
4.1.0-alpha.11 96 9/19/2023
4.1.0-alpha.10 78 9/19/2023
4.1.0-alpha.9 96 9/17/2023
4.1.0-alpha.8 73 9/16/2023
4.1.0-alpha.6 165 9/9/2023
4.1.0-alpha.5 75 9/8/2023
4.1.0-alpha.4 128 9/5/2023
4.1.0-alpha.3 83 9/2/2023
4.1.0-alpha.2 99 8/26/2023
4.1.0-alpha.1 73 8/25/2023
4.1.0-alpha.0 78 8/24/2023
4.0.6 1,252 10/2/2023
4.0.5 100 9/28/2023
4.0.5-pre.3 70 9/19/2023
4.0.5-pre.2 66 9/18/2023
4.0.5-pre.1 195 9/15/2023
4.0.5-pre.0 74 9/15/2023
4.0.4 249 9/13/2023
4.0.4-pre.1 84 9/7/2023
4.0.4-pre.0 85 8/29/2023
4.0.4-alpha.2 208 8/21/2023
4.0.4-alpha.0 132 8/10/2023
4.0.3 963 8/3/2023
4.0.3-pre.7 123 7/27/2023
4.0.3-pre.6 92 7/26/2023
4.0.3-pre.5 99 7/24/2023
4.0.3-pre.4 105 7/23/2023
4.0.3-pre.3 95 7/23/2023
4.0.3-pre.2 88 7/22/2023
4.0.3-pre.1 112 7/19/2023
4.0.3-pre.0 116 7/17/2023
4.0.2 416 7/17/2023
4.0.2-pre.8 93 7/17/2023
4.0.2-pre.7 90 7/17/2023
4.0.2-pre.6 87 7/16/2023
4.0.2-pre.5 99 7/15/2023
4.0.2-pre.4 90 7/14/2023
4.0.2-pre.3 93 7/11/2023
4.0.2-pre.2 123 7/7/2023
4.0.2-pre.1 127 7/3/2023
4.0.1 1,039 6/9/2023
4.0.1-pre.14 88 6/8/2023
4.0.1-pre.13 91 6/6/2023
4.0.1-pre.12 80 6/5/2023
4.0.1-pre.11 94 6/1/2023
4.0.1-pre.10 82 5/31/2023
4.0.1-pre.9 81 5/30/2023
4.0.1-pre.8 95 5/26/2023
4.0.1-pre.7 91 5/25/2023
4.0.1-pre.6 82 5/25/2023
4.0.1-pre.5 107 5/20/2023
4.0.1-pre.4 84 5/19/2023
4.0.1-pre.3 88 5/17/2023
4.0.1-pre.2 109 5/12/2023
4.0.1-pre.1 118 5/10/2023
4.0.1-pre.0 87 5/10/2023
4.0.0 682 5/7/2023
4.0.0-test.11 134 4/28/2023
4.0.0-test.10 98 4/27/2023
4.0.0-beta.12 89 5/1/2023
4.0.0-beta.11 91 4/28/2023
4.0.0-beta.10 90 4/26/2023
4.0.0-beta.9 151 4/21/2023
4.0.0-beta.8 89 4/18/2023
4.0.0-beta.7 98 4/16/2023
4.0.0-beta.6 95 4/16/2023
4.0.0-beta.5 91 4/14/2023
4.0.0-beta.4 88 4/13/2023
4.0.0-beta.3 95 4/13/2023
4.0.0-beta.2 96 4/12/2023
4.0.0-beta.1 94 4/11/2023
4.0.0-beta.0 97 4/6/2023
4.0.0-alpha.18 90 4/5/2023
4.0.0-alpha.17 92 4/5/2023
4.0.0-alpha.15 92 4/5/2023
4.0.0-alpha.14 92 4/5/2023
4.0.0-alpha.13 98 4/4/2023
4.0.0-alpha.12 95 4/2/2023
4.0.0-alpha.11 96 4/1/2023
4.0.0-alpha.10 96 3/31/2023
4.0.0-alpha.9 105 3/27/2023
4.0.0-alpha.8 101 3/24/2023
4.0.0-alpha.7 106 3/22/2023
4.0.0-alpha.6 101 3/22/2023
4.0.0-alpha.5 96 3/19/2023
4.0.0-alpha.4 98 3/16/2023
4.0.0-alpha.3 96 3/14/2023
4.0.0-alpha.2 98 3/13/2023
4.0.0-alpha.1 88 3/12/2023
4.0.0-alpha.0 98 3/12/2023
3.4.5 506 4/14/2023
3.4.4 178 4/13/2023
3.4.3 157 4/11/2023
3.4.3-pre.2 98 4/3/2023
3.4.3-pre.1 104 3/23/2023
3.4.3-pre.0 101 3/14/2023
3.4.2 580 3/14/2023
3.4.2-pre.5 100 3/13/2023
3.4.2-pre.4 149 3/2/2023
3.4.2-pre.3 156 2/22/2023
3.4.2-pre.2 117 2/22/2023
3.4.2-pre.1 111 2/21/2023
3.4.2-pre.0 117 2/20/2023
3.4.1 231 2/20/2023
3.4.1-pre.9 117 2/15/2023
3.4.1-pre.8 103 2/15/2023
3.4.1-pre.7 123 2/12/2023
3.4.1-pre.6 104 2/11/2023
3.4.1-pre.5 115 2/10/2023
3.4.1-pre.4 124 2/4/2023
3.4.1-pre.3 153 1/25/2023
3.4.1-pre.2 152 1/18/2023
3.4.1-pre.1 139 1/12/2023
3.4.1-pre.0 118 1/12/2023
3.4.0 135 1/7/2023
3.4.0-pre.16 118 12/29/2022
3.4.0-pre.15 110 12/23/2022
3.4.0-pre.14 111 12/21/2022
3.4.0-pre.13 114 12/21/2022
3.4.0-pre.12 121 12/19/2022
3.4.0-pre.11 144 12/12/2022
3.4.0-pre.10 128 12/8/2022
3.4.0-pre.9 145 12/2/2022
3.4.0-pre.8 124 12/1/2022
3.4.0-pre.7 128 11/29/2022
3.4.0-pre.6 124 11/27/2022
3.4.0-pre.5 112 11/26/2022
3.4.0-pre.4 117 11/24/2022
3.4.0-pre.3 115 11/23/2022
3.4.0-pre.2 139 11/21/2022
3.4.0-pre.1 118 11/20/2022
3.4.0-pre.0 120 11/18/2022
3.3.20-pre.3 144 11/9/2022
3.3.20-pre.2 121 11/8/2022
3.3.20-pre.1 139 11/4/2022
3.3.20-pre.0 147 10/31/2022
3.3.19 162 10/21/2022
3.3.19-pre.2 147 10/20/2022
3.3.19-pre.1 134 10/17/2022
3.3.19-pre.0 123 10/14/2022
3.3.18 153 10/10/2022
3.3.18-pre.8 129 10/7/2022
3.3.18-pre.7 145 10/2/2022
3.3.18-pre.6 128 9/29/2022
3.3.18-pre.5 126 9/29/2022
3.3.18-pre.4 124 9/29/2022
3.3.18-pre.3 121 9/29/2022
3.3.18-pre.2 120 9/28/2022
3.3.18-pre.1 122 9/28/2022
3.3.17 169 9/26/2022
3.3.16 131 9/24/2022
3.3.16-pre.5 122 9/22/2022
3.3.16-pre.4 128 9/20/2022
3.3.16-pre.3 124 9/19/2022
3.3.16-pre.2 130 9/15/2022
3.3.16-pre.1 131 9/15/2022
3.3.16-pre.0 129 9/14/2022
3.3.15 192 9/11/2022
3.3.14 140 9/9/2022
3.3.14-test.0 136 9/6/2022
3.3.14-pre.1 135 9/7/2022
3.3.14-pre.0 141 8/26/2022
3.3.13 246 8/24/2022
3.3.13-pre.3 158 8/21/2022
3.3.13-pre.2 151 8/20/2022
3.3.13-pre.1 149 8/19/2022
3.3.13-pre.0 147 8/18/2022
3.3.12 174 8/15/2022
3.3.12-pre.5 151 8/14/2022
3.3.12-pre.4 156 8/14/2022
3.3.12-pre.3 160 8/12/2022
3.3.12-pre.2 162 8/9/2022
3.3.12-pre.1 151 8/9/2022
3.3.12-pre.0 155 8/9/2022
3.3.11 235 8/1/2022
3.3.10 168 7/31/2022
3.3.10-pre.6 164 7/31/2022
3.3.10-pre.5 156 7/27/2022
3.3.10-pre.4 148 7/25/2022
3.3.10-pre.3 158 7/24/2022
3.3.10-pre.2 158 7/19/2022
3.3.10-pre.1 159 7/18/2022
3.3.10-pre.0 173 7/12/2022
3.3.9 190 6/30/2022
3.3.8 197 6/15/2022
3.3.8-pre.3 161 6/15/2022
3.3.8-pre.2 174 6/8/2022
3.3.8-pre.1 167 6/6/2022
3.3.7 206 5/24/2022
3.3.6 182 5/24/2022
3.3.5 180 5/22/2022
3.3.4 191 5/16/2022
3.3.4-pre.1 173 5/12/2022
3.3.4-pre.0 179 5/11/2022
3.3.3 231 5/6/2022
3.3.3-cli-test.16 182 5/5/2022
3.3.3-cli-test.12 179 5/5/2022
3.3.3-cli-test.9 181 5/4/2022