TIBET Logo

TIBET manpages

Man Pages

wins

  • Markup-driven documentation of all TIBET CLI and project commands.
  • Standardized UNIX man-page format for command line documentation.
  • Automatic generation of both command line and HTML index and pages.
  • Documentation generation fully built-in to project build process.

contents

concepts

commands

code


concepts

TIBET's manual pages (aka "manpages") serve as documentation for the TIBET CLI and other topics. These pages are available both from the command line and from any browser.

You can create your own manpages for any commands, concepts, coding standards, etc. you wish to associate with your project as we'll show in this guide.

When using the tibet help command to view a manpage TIBET prefixes the topic name. TIBET-authored topics always display a tibet- prefix and your own topics typically will display a {project.name}- prefix such as hello-sample for a hello project.

Below we show help on the help command itself via tibet help help:

tibet help help

TIBET-HELP(1)                                                   TIBET-HELP(1)

NAME
    tibet-help - displays help specific to TIBET

SYNOPSIS
    tibet help <topic>

DESCRIPTION
    Displays help for a specific command or the 'tibet' command.

    You can alternatively get usage data via the --usage flag on each command or
    complete help output by using the --help flag on the target command.

EXAMPLES
    List help on the tibet command itself.

    $ tibet

    Usage: tibet <command> <options>

    The tibet command can invoke TIBET built-ins, custom commands, tibet
    makefile.js targets, grunt targets, or gulp targets based on your project
    configuration and your specific customizations.

     <command> built-ins include:

        appcache apropos clone config context deploy doclint echo freeze help
        init lint make package quickstart reflect resources rollup start
        tag test thaw tsh user version

     makefile.js targets include:

         build checkup clean deploy resources rollup

     <options> always include:

         --help         display command help text
         --usage        display command usage summary
         --color        colorize the log output [true]
         --verbose      work with verbose output [false]
         --debug        turn on debugging output [false]
         --stack        display stack with error [false]

     Configure default parameters via 'tibet config'.

     hello@0.1.0 /Users/ss/.nvm/v0.10.36/bin/tibet

                            July 2019                           TIBET-HELP(1)
Authoring Help

You can create your own manpages for topics in your applications by creating markdown files and placing them in the ~app/doc/markdown directory. By default all TIBET projects include a {project.name}-sample.md file in this directory to give you a starting point.

Generating Help

Use the tibet build_docs target to specifically build docs.

Use tibet build to build your entire project, including documentation.


commands (TIBET)

appcache(1)
-- manages the HTML appcache for a particular project
apropos(1)
-- searches TIBET documentation for docs matching a keyword
clone(1)
-- clones a project from a template directory
config(1)
-- manages and displays TIBET configuration data
context(1)
-- outputs current context information to stdout
couch(1)
-- manage CouchDB databases and applications
decrypt(1)
-- decrypt a string using the TDS.decrypt approach
deploy(1)
-- deploys an application via `shipit` or `tibet make`
doclint(1)
-- validates method comment content
echo(1)
-- echo command line arguments to stdout
electron(1)
-- start a TIBET electron application
encrypt(1)
-- encrypt a string using the TDS.encrypt approach
freeze(1)
-- freezes the current project's TIBET library
help(1)
-- displays help specific to TIBET
init(1)
-- initialize a TIBET project
lint(1)
-- runs various lint tools on package files
make(1)
-- runs a TIBET makefile.js target
open(1)
-- open a file using the OS open command
package(1)
-- list package assets either as asset paths or nodes
path(1)
-- resolve and print expanded virtual path value
quickstart(1)
-- outputs first steps for new TIBET users
reflect(1)
-- reflects on TIBET objects and methods
resource(1)
-- builds template/css/resource files and config entries
rollup(1)
-- concatenates a package@config's resources
start(1)
-- starts the project's TIBET Data Server
tds(1)
-- starts the project's TIBET Data Server
test(1)
-- runs unit/functional tests on your application
thaw(1)
-- thaws a frozen project's TIBET library reference
tsh(1)
-- runs a TIBET Shell (TSH) expression
tws(1)
-- manage CouchDB databases and applications
type(1)
-- creates a new TIBET type
user(1)
-- adds/updates user configuration data
version(1)
-- displays the current project and TIBET version

code

The code for all CLI commands is found in ~/lib/src/tibet/cli.

The build tasks build and build_docs are found in ~app/cmd/make along with all tibet make targets specific to your project.

The markdown files for TIBET CLI commands are found in ~lib/doc/markdown (a parallel directory to where your own project-specific source documentation would reside).