Builtin Tasks¶

The following is a summary of all built in tasks that are shipped with bash task master.

In the examples all arguments are given in their long form, but short arguments are also accepted. The short form arguments are standardized as the first letter of the long form. For example, the short form of --dir would be -d.

This information can also be easily accessed by running task help COMMAND_NAME.

Init¶

Initialize a local task file.

# Create a .tasks.sh file in the current directory
# Uses the default bash template
# Adds a bookmark with the directory name
task init

# Create a tasks.sh file in target directory and names it project
task init --dir target --name project

# Create a .tasks.sh file from a given template
task init --template custom

# Create default task file for mydriver
# If a template does not exist, create an empty task file that uses the naming convention of mydriver
# NOTE: -D is the short argument for --driver
task init --driver mydriver

List¶

List available tasks.

# List all tasks available
task list

# List all global tasks
task list --global

# List all local tasks
task list --local

Edit¶

Edit the current local task file. Opens the editor specified in the DEFAULT_EDITOR variable in $TASK_MASTER_HOME/config.sh. After exiting the editor bash-task-master will check that the tasks.sh file is valid bash. If the file is not valid it will give you the option to either open it back up or revert the changes.

task edit

Bookmark¶

Bookmark locations.

# Bookmark the current directory
# Uses the current directory as it's name
task bookmark

# Bookmark the current directory as loc
task bookmark --name loc

# Create a bookmark to some/other/dir named mydir
task bookmark --dir some/other/dir --name mydir

# List bookmarks
task bookmark list

# Remove a bookmark
task bookmark rm --name mybookmark

Goto¶

Change directories to previously bookmarked locations.

Goto a bookmark named location:

task goto location

Help¶

Show Help.

# Show help for mycommand
task help mycommand

Template¶

Manage task file templates

# Edit the default bash template
task template edit --name bash

# Edit/create a new custom template
task template edit --name custom

# Remove the custom template
task template rm --name custom

# List templates
task template list

Module¶

Manage local modules.

# Enable mymodule
# Searches TASK_REPOS for the module if it not found locally.
task module enable --name mymodule

# Disable mymodule
task module disable --name mymodule

# List all enabled or disabled modules
task module list --all

# List all remotely available modules
task module list --remote

# List all enabled modules
task module list --enabled

# List all diabled modules
task module list --disabled

Driver¶

Manage task drivers

# Enable mydriver
# Searches TASK_REPOS for the driver if it is not found locally
task driver enable --name mydriver

# Disable mydriver
task driver disable --name mydriver

# List installed drivers
task driver list

# List drivers available remotely
task driver list --remote

Global¶

Global debug information. Manage global variables and state.

# Show all current variables
task global debug

# Show current variables for the build command:
task global debug --command build

# Set a variable for a command.
# For example, to set myvar to 10 for the build command:
task global set --key myvar --value 10 --command build

# Remove a variable for a command.
# For example, to unset myvar for the build command:
task global unset --key myvar --command build


# Edit the variables for a command.
# Uses the `DEFAULT_EDITOR` setting in `$TASK_MASTER_HOME/config.sh` as the editor.
# For example, to edit the settings for the clean command:
task global edit --command clean


# Clean up empty locations and stale location files.
# This will remove any state files with no values in them and remove any bookmarks that refer to non existant locations.
task global clean