Skip to content

Commands

Hamad Almarri edited this page May 20, 2017 · 1 revision

Universal Commands

Commands are available in all views

clear

Clear the terminal scree

exit

Exit/terminate the program

dashboard

Go to dashboard

go_to dashboard

Go to dashboard

help

Show help

Dashboard Commands

Commands are available in Dashboard view

go_to

Go to a project and open the project view (followed by a project name)

go_to project

Similar to 'go_to', it goes to a project and open the project view (followed by a project name)

add project

Create a new project

edit project

Edit project (followed by a project name)

remove project

Remove or delete project (followed by a project name)

Project Commands

Commands are available in Project view

show

Show project information

releases

List all releases

sprints

List all sprints

user_stories

List all user stories

tasks

List all tasks

plan

Show plan in short form as a tree

plan details

Show plan in details in a table

backlog

List user stories in the backlog

show backlog

Similar to backlog, list user stories in the backlog
Optional: (filter) to filter out the results (ex. show backlog filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. show backlog sort column_name)
use TAB to autocomplete column names
repeating show backlog command with sort option toggles order between ASC and DESC

list releases

List all releases
Optional: (filter) to filter out the results (ex. list releases filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. list releases sort column_name)
use TAB to autocomplete column names
repeating list command with sort option toggles order between ASC and DESC

list sprints

List all sprints
Optional: (filter) to filter out the results (ex. list sprints filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. list sprints sort column_name)
use TAB to autocomplete column names
repeating list command with sort option toggles order between ASC and DESC

list user_stories

List all user stories
Optional: (filter) to filter out the results (ex. list user_stories filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. list user_stories sort column_name)
use TAB to autocomplete column names
repeating list command with sort option toggles order between ASC and DESC

back

Go back to previous view (Dashboard)

go_to backlog

Go to backlog view

go_to release

Go to a release view (followed by a release name)

go_to sprint

Go to a sprint view (followed by a sprint name)

go_to user_story

Go to a user story view (followed by a user story name)

go_to releases

Go to all releases view

go_to sprints

Go to all sprints view

go_to planner

Go to planner view

add release

Add new release

add sprint

Add new sprint

add user_story

Add new user story to the backlog

Backlog Commands

Commands are available in Backlog view

user_stories

List all user stories

list user_stories

List all user stories
Optional: (filter) to filter out the results (ex. list user_stories filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. list user_stories sort column_name)
use TAB to autocomplete column names
repeating list command with sort option toggles order between ASC and DESC

back

Go back to previous view (Project)

go_to user_story

Go to a user story view (followed by a user story name)

add user_story

Add new user story to the backlog

Releases Commands

Commands are available in Releases view

releases

List all releases

back

Go back to previous view (Project)

go_to release

Go to a release view (followed by a release name)

add release

Add new release

Release Commands

Commands are available in Release view

show

Show release information

edit

Edit release

change_status_to

Change status of release (use TAB to autocomplete)
Status: created, open, planned, unplanned, in_progress, in_testing, done, overdue, removed

sprints

List sprints planned in this release

list sprints

List sprints planned in this release
Optional: (filter) to filter out the results (ex. list sprints filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. list sprints sort column_name)
use TAB to autocomplete column names
repeating list command with sort option toggles order between ASC and DESC

back

Go back to previous view

go_to sprint

Go to a sprint view (followed by a sprint name)

Sprints Commands

Commands are available in Sprints view

sprints

List all sprints

back

Go back to previous view (Project)

go_to sprint

Go to a sprint view (followed by a sprint name)

add sprint

Add new sprint

Sprint Commands

Commands are available in Sprint view

show

Show sprint information

edit

Edit sprint

change_status_to

Change status of sprint (use TAB to autocomplete)
Status: created, open, planned, unplanned, in_progress, in_testing, done, overdue, removed

user_stories

List user stories planned in this sprint

list user_stories

List user stories planned in this sprint
Optional: (filter) to filter out the results (ex. list user_stories filter a_string)
Optional: (sort) to sort the results based on a chosen column (ex. list user_stories sort column_name)
use TAB to autocomplete column names
repeating list command with sort option toggles order between ASC and DESC

back

Go back to previous view

go_to user_story

Go to a user story view (followed by a user story name)

add user_story

Add new user story to this sprint

User Story Commands

Commands are available in User Story view

show

Show user story information

edit

Edit user story

change_status_to

Change status of user story (use TAB to autocomplete)
Status: created, open, planned, unplanned, in_progress, in_testing, done, overdue, removed

tasks

List tasks planned to this user story

back

Go back to previous view

go_to task

Go to a task view (followed by a task name)

add task

Add new task to this user story

Task Commands

Commands are available in Task view

show

Show task information

edit

Edit task

change_status_to

Change status of task (use TAB to autocomplete)
Status: created, open, planned, unplanned, in_progress, in_testing, done, overdue, removed

back

Go back to previous view

Planner Commands

Commands are available in Planner view

releases

List all releases

sprints

List all sprints

user_stories

List all user stories

backlog

List user stories in the backlog

plan

Show plan in short form as a tree

plan details

Show plan in details in a table

show releases

Similar to releases, list all releases

show sprints

Similar to sprints, list all sprints

show user_stories

Similar to user_stories, list all user stories

show backlog

Similar to backlog, list user stories in the backlog

show plan

Similar to plan, show plan in short form as a tree

show plan details

Similar to plan details, show plan in details in a table

move sprint# to release#

Move (or plan) sprint to release where sprint# is a sprint name and release# is a release name
use TAB to autocomplete sprint and release names

move user_story# to sprint#

Move (or plan) user story to sprint where user_story# is a user story name and sprint# is a sprint name
use TAB to autocomplete user story and sprint names

unplan sprint#

Unplan sprint where sprint# is a sprint name
use TAB to autocomplete sprint names

unplan user_story#

Unplan user story and move it back to the backlog where user_story# is a user story name
use TAB to autocomplete user story names

unplan all

Unplan all user stories and sprints

back

Go back to previous view (Project)