Skip to content

Using the command-line interface

This tutorial is for users who have never used a command-line interface, or have little experience with using a terminal (a.k.a. "command line"). If you are comfortable with command line interfaces in general, head over to the CLI reference.

1. Opening a terminal

To run commands, you first need a terminal window (sometimes called a "command prompt" in Windows, because it prompts you to enter a command). There are many ways to do this, but we will discuss just one. (Read here for more ways to do this.)

  1. Open the folder where you want to run the command prompt.
  2. Press Ctrl + L to edit the location bar at the top of the window.

    windows-location-bar

  3. Type cmd and hit Enter.

    windows-location-bar

    This opens the Command Prompt with this folder as the working directory.

    windows-location-bar

2. Exploring the available commands

  1. Type autory --help and hit Enter.

    autory-run-help

    Congratulations! You have successfully opened the Command Prompt and run your first command.

    Almost all commands have a --help option. For the autory command, the output of --help is also available here.

  2. Type autory new --help and hit Enter. You will see the documentation for the autory new command.