anax/anax-cli

Anax CLI tool.

Anax CLI

, _(*1)

A CLI client to work with Anax web sites, built in bash., _(*2)

Install

This is how you download and install the skript. You can review the contents of the install script in src/install.bash., _(*3)

bash -c "$(curl https://raw.githubusercontent.com/canax/anax-cli/master/src/install.bash)"

Or like this., _(*4)

curl https://raw.githubusercontent.com/canax/anax-cli/master/src/install.bash | bash

Install using composer., _(*5)

composer require anax/anax-cli

Usage

Check that the script works by checking its version., _(*6)

$ anax version
v1.1.11 (2018-10-31) 

Check whats can be done using the script., _(*7)

$ anax help                                                                
Utility to work with Anax web sites. Read more on:                         
https://dbwebb.se/anax-cli/                                                
Usage: anax [options] <command> [arguments]                                

Command:                                                                   
 check                    Check and display details on local environment.  
 config                   Create base for configuration in $HOME/.anax/.   
 create <dir> <template>  Create a new site in dir using a template.       
 help                     Show info on how to use it.                      
 list                     List available templates for scaffolding from.   
 list <template>          List details on specific scaffolding template.   
 selfupdate               Update to latest version.                        
 version                  Show info on how to use it.                      

Options:                                                                   
 --help, -h          Show info on how to use it.                           
 --version, -v       Show info on how to use it.                           
 --force, -f         Force operation even though it should not.            

Scaffold

List the available templates that can be scaffolded., _(*8)

anax list

List details on a template, for example anax-flat-site., _(*9)

anax list anax-flat-site

Scaffold a website using the selected template and save it all to the directory dir., _(*10)

anax create dir anax-flat-site

The site is scaffolded and you can open your webbrowser to the site by opening dir/htdocs., _(*11)

Processing scripts

During scaffolding a couple of scripts are executed, these are in general included with each module using to carry out the scaffolding., _(*12)

The base dir for these scripts are .anax., _(*13)

Templates for scaffolding

The templates used for scaffolding resides in anax/scaffold., _(*14)

The specific template used resides in that repo under scaffold/template-name. You can for example review the template used for anax-flat-site., _(*15)

License

This software carries a MIT license., _(*16)

 .  
..:  Copyright (c) 2013 - 2018 Mikael Roos, mos@dbwebb.se