Shift.Core.Sdk 0.0.1-prerelease

Shift CLI

• Shift Core
  • manifest.json
  • Specifying the task
    • Powershell Task
    • Custom Task
  • Specifying a network directory location
  • Update a version in the manifest
• Shift CLI Commands

Introduction

Shift CLI is a command line interface tool that surfaces Shift Core functionality.

Shift Core

Shift always comes in pairs with a manifest file. A manifest file is a list of components and tasks that makes up a product. Think of components as lego pieces, and the tasks as an instruction set. Shift downloads the components from the location specified in the manifest file, and performs a set of instructions specified sequentially. Essentially, Shift Core analyzes and interprets the manifest file.

manifest.json

Manifest contains a list of components, a list of bundles, component locations, and component tasks. Below is an example of a manifest file.

{
  "Version": "{{VERSION}}",
  "Components": [
    {
      "id": "nullTaskComponent",
      "description": "Component with no task",
      "owner": "chaelee",
      "deviceDemands": [ "windows", "pc" ],
      "location": {
        "organization": "microsoft",
        "project": "180A7408-2DEB-44D9-AE8D-992FA4C3B9A6",
        "feed": "Product.Components.Release",
        "name": "nullTaskComponent",
        "version": "0.1.0"
      },
      "task": null
    },
  ],
  "Bundles": [
    {
      "bundles": [],
      "components": [
        "nullTaskComponent"
      ],
      "description": "The default bundle",
      "id": "default"
    }
  ]
}

Specifying the task

Powershell task

You can specify a PowerShell task as below:

{
    "id": "pwshTaskComponent",
    "description": "Test component with powersell task type",
    "owner": "chaelee",
    "deviceDemands": [ "windows", "pc" ],
    "location": {
        "organization": "microsoft",
        "project": "180A7408-2DEB-44D9-AE8D-992FA4C3B9A6",
        "feed": "Product.Components.Release",
        "name": "pwshTaskComponent",
        "version": "0.1.0"
    },
    "task": {
        "type": "pwsh",
        "script": "echo \"Hello, Shift\""
    }
}

Custom task

Shift also allows you to specify custom tasks. This is done through writing a custom plugin for your product. Implement the abstract class PluginDefinition, and add it to the list of plugin definitions in the Program.cs file within the cli project. Below is an example component with a custom plugin task. Reach out to chaelee@microsoft.com for questions.

{
    "id": "pluginTaskComponent",
    "description": "Test component with plugin task type",
    "owner": "chaelee",
    "deviceDemands": [ "headset" ],
    "location": {
        "organization": "microsoft",
        "project": "180A7408-2DEB-44D9-AE8D-992FA4C3B9A6",
        "feed": "Product.Components.Release",
        "name": "pluginTaskComponent",
        "version": "0.1.0"
    },
    "task": {
        "type": "customPluginName",
        "action": "HeadsetInstall"
    }
}

Specifying a network directory location

You can also specify the network directory location to copy the file. This is not advised since it may be unreliable and we are unsure how long we will support this.

{
    "id": "directoryTestComponent",
    "description": "Tests a component that is download only, no task.",
    "owner": "chaelee",
    "deviceDemands": [ "windows", "pc" ],
    "location": {
        "path": "\\\\mrfs\\private\\openxr\\ARDK-WinInProcVulkan\\CannonDemo"
    }
}

Shift CLI commands

shift.exe init --path [path to the local manifest file]

Downloads and installs the specified local manifest.

shift.exe install [path to the local manifest file] -c [components] -v [versions] -b [bundle]

Install a specific component This command lets you download and install a specific component. You may input a single component by its id, or a comma-separated list of components. If you do not input a version number, the version number from the lkg (latest-stable) build will be grabbed. If you want to install multiple components but want to specify a single version number, version input should also be a comma-separated list of versions. Notice the commas in the below example:

shift.exe download [path to the local manifest file] -c [components] -v [versions] -b [bundle]

This command lets you download a specific component. You may input a single component by its id, or a comma-separated list of components. If you do not input a version number, the version number from the lkg (latest-stable) build will be grabbed. If you want to download multiple components but want to specify a version number for a specific component, version input should also be a comma-separated list of versions. Notice the commas in the below example:

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.