Command Line Tool
The codetour command line tool is called ct
.
Just running ct
alone is the same as running ct build
without any arguments.
See the build command for more information.
--help
When you use the --help
(-h
) flag, codetour will show a description of the
command, flags that it supports, and its subcommands. After printing that
information, the program will immediately exit.
Every subcommand also supports a --help
(-h
) flag for showing the specific
help information for that subcommand. This flag is fairly common in most
command-line applications, so we do not document it on the page for every
subcommand.
You can also use ct help <subcommands>...
to seek information about a specific
ct
subcommand.
--version
When you use the --version
(-V
) flag, codetour will print the name of the
application, followed by the current version installed on your computer.
This is a great piece of information to provide in bug reports so we know what version of codetour you are using.
Run in any subdirectory
The ct
command and any of its subcommands can be run in any subdirectory of
your project. As long as a tour.toml
file is in one of the parent directories,
the project will be detected automatically. The command will be run as if you
ran it in the directory of that configuration file.
Subcommands
Each of the ct
subcommands are described throughout the rest of this section.