Using the CLI

Last updated 5 months ago

Once you install Mint you will have a mint binary at your disposal.

This is the help section (you can print this using the --help flag):

mint --help
Mint - Help
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Usage:
mint [flags...] [arg...]
Mint
Flags:
--help # Displays help for the current command.
Subcommands:
build # Builds the project for production
docs # Starts the documentation server
format # Formats source files
init # Initializes a new project
install # Installs dependencies
loc # Counts Lines of Code
start # Starts the development server
test # Runs the tests
version # Shows version
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Initializing a new application

To initialize a new application, you invoke the binary with the init command:

mint init my-app

This will scaffold a new application in the my-app directory:

my-app
├── source
│ └── Main.mint
├── tests
│ └── Main.mint
├── .gitignore
└── mint.json

Installing dependencies

You install dependencies by invoking the binary with the install command:

mint install

This builds a dependency tree of the packages and installs them by cloning their repositories from Git sources into the .mint directory.

Starting a development server

To start a development server for an application, just invoke the binary with the start command:

mint start

Running tests

To run the test written for an application, just invoke the binary with the test command:

mint test

This will:

  • compile the application including the tests

  • open a browser in headless mode

  • run the tests in the browser printing the results along the way

Building for production

To build the application for production deployment, invoke the binary with the build command:

mint build

This will:

  • generate the index.html file

  • compile the application in production mode

  • if a base icon is provided, generate favicons in different sizes

  • copy all static files from the public directory

Browsing documentation of installed packages

To browse the documentation of the application and installed packages, invoke the binary with the `docs` command:

mint docs

It starts a documentation server which can be accessed at http://localhost:3002