Skip to content

dime-scheduler/cli

Repository files navigation

Dime.Scheduler CLI

Connect with Dime.Scheduler through the CLI. Check out the 📚 docs for all the information on the CLI.

Installation

🚧 The Dime.Scheduler is currently in preview mode.

To install the CLI, open the command-line in Windows and run the following command:

dotnet tool install Dime.Scheduler.CLI --global

For more information on the installation, check out the package on NuGet.

Prerequisites

To clone and run this application, you'll need Visual Studio 16.7 or higher. The application is built with C# 10 and targets .NET 6.0.

Usage

The following example adds or updates a category in Dime.Scheduler:

dimescheduler category add -k "MYAPIKEY" -n 'Service order 123' -h #32a852

To specify an environment, add --env followed by either Dev, Test, or Staging.

The entry point of the global tool is the dimescheduler command.

See the 📚 docs for a list of all commands and their parameters.

To see the parameters of a command, simply run the dimescheduler + verb + entity + --help command and you'll get all the information you need:

Contributing

We welcome contributions. Please check out the contribution and code of conduct guidelines first.

To contribute:

  1. Fork the project
  2. Create a feature branch (git checkout -b feature/mynewfeature)
  3. Commit your changes (git commit -m 'Add mynewfeature')
  4. Push to the branch (git push origin feature/mynewfeature)
  5. Open a pull request