Quick Start

Quick Start

You're in luck, getting started is really easy. All you need to do is download the installer for your operating system and run it. Currently we offer installers for Linux (.deb), MacOS (.dmg), and Windows (.msi).

See the Downloads page to download an installer. After installing, open a new terminal window. Note that if you had one open you'll likely need to open a brand new one after installation or the command won't be found. Run the aussom command with the version option to verify it's working correctly. It should look something like this.

$ aussom -v 
Aussom-Lang Version 1.0.0
Copyright 2024 Austin Lehman
GNU General Public License Version 3

Next run it again with the help (-h) option. This is helpful to list all the options for the cli.

$ aussom -h
usage: aussom [options] <aussom-file>
 -ag,--arcgen          runs the Aussom archetype generate program
 -d,--doc              generate aussomdoc for file
 -h,--help             print this message
 -l,--loglevel <arg>   set the log level (trace, debug, info, warning,
                       error)
 -o,--outdir <arg>     the output directory to place the generated
                       aussomdoc file
 -od,--opendoc         opens the Aussom documentation in the system
                       browser
 -v,--version          print the version information

Notice in the list the -od (open doc) option. Try that one out next, it's very useful. It opens a page with all the API docs for your version of Aussom in your local browser.

$ aussom -od

That's about it for the quick start guide. Check out the Aussom Language Overview guide next for a lot more information about the language.