General Usage

imakewebthings edited this page Apr 8, 2012 · 1 revision

Usage

Creating Local Projects

Using consular is quite easy. To define or edit a project file, simply invoke the command:

$ consular edit foo

This will open your default editor (set through the $TERM_EDITOR or $EDITOR variable in BASH) and you can proceed to define the commands for that project with the following syntaxes:

YAML Syntax ( Legacy )

# ~/.config/consular/foo.yml
# you can make as many tabs as you wish...
# tab names are actually arbitrary at this point too.
---
- tab1:
  - cd ~/foo/bar
  - gitx
- tab2:
  - mysql -u root)
  - use test;
  - show tables;
- tab3: echo "hello world"
- tab4: cd ~/baz/ && git pull
- tab5:
  - cd ~/foo/project
  - autotest

Simply define each tab and declare the commands. Note that the session for each tab is maintained, so you just declare actions here as you would manually type in the terminal. Note that the title for each tab(namely tab1, tab2) are arbitrary, and can be named whatever you want. They are simply placeholders for the time being for upcoming features.

To use the legacy syntax, you can invoke it with consular by appending the 'yml' file extension like so:

$ consular edit foo.yml

It is recommended that you move over to the newer Ruby DSL Syntax as it provides more robust features, however consular will still support the older YAML syntax.