Skip to content

hypertherm/cutchart-cli

Repository files navigation

Cut Chart Command-Line Interface (cc-cli.exe)

Do you want to work with Hypertherm Cut Chart data from your command line?

Simply download our Cut Chart CLI executable file and use the commands below.

This command-line interface uses the Hypertherm Cut Chart API and its OpenAPI specification.

Installation

Minimum requirements

  • Windows 7, 8, or 10

Download and save the executable (.exe) file from the cutchart-cli releases page into the local folder of your choice.

Get started

From your command line, navigate to the folder where the executable file is saved.

Next, type the name of the executable followed by a:

  1. A basic command (products, cutchart, customs)
  2. An optional argument (if desired)

Basic commands

The following commands are available for working with cut chart data:

  • products: Lists products with available cut chart data, such as Powermax105 or MAXPRO200.
  • cutchart: Downloads cut chart data for a given product.
  • customs: Downloads modified cut chart data based on the provided XML schema.

Basic use example

Find out what Hypertherm products have cut chart data available.

cc-cli products

The request and response for the products endpoint could look like this:

This is an example

Optional arguments

These are the available command arguments:

  • [-h | --help]
  • [-v | --version]
  • [-u | --update]
  • [-d | --dumplog]
  • [-c | --clearlog]
  • [-p | --product]
  • [-o | --outfile]
  • [-x | --xmlfile]
  • [-u | --units]
  • [-t | --type]
  • [-l | --logout]

Examples

  • Find out what commands and arguments are available.

    cc-cli -h
    

    The request and response for viewing commands and arguments could look like this: This is an example request for help from the command line

  • Download modified Powermax105 cut chart data, based on the provided XML file.

    cc-cli customs -p powermax105 -x myStyle.xml -o cc.xlsx
    

    The request and response for uploading an XML file (myStyle.xml) to the customs endpoint and downloading the updated Powermax105 cut chart data outfile (cc.xlsx) could look like this: This is an example of customizing cut chart data with an XML file from the command line

    In this example:

    • myStyle.xml defines how to customize cut chart data. This file must be saved in the same location as the cc-cli executable file before making the request. For testing purposes, you can use the myStyle.xml file provided in this repo.

    • cc.xlsx is automatically created to provide updated cut chart data. Once the "Success" response is returned, look for this file in the same location as your XML file.

    Name the XML file and the outfile whatever you want.

  • Check for and apply updates

    Check for the latest updates or choose from all released versions.

    cc-cli --update
    

    When updating, a backup of the current version is saved to "%APPDATA%\cc-cli\versions".

  • Interact with the Log file

    Print out the entire log history.

    cc-cli --dumplog
    

    Clear the log history.

    cc-cli --clearlog
    

About

Command-line tool for interacting with Hypertherm Cut Chart API services

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages