Skip to main content

TeamForge CLI-Introduction and Basic Navigation

The Digital.ai TeamForge command line interface (CLI) lets you navigate a TeamForge site, work with lists of data and individual objects such as tracker artifacts and wiki pages, and build a wide range of reports.

This page covers general navigation, the command levels available at each prompt, the built-in help system, and the convenience commands that get you to a project or tool quickly. For working with the lists these commands return, see Working with Lists. For individual command syntax, see the Command Reference. For worked examples, see the Cookbook.

Basic Navigation​

Every CLI session starts at the ctf> prompt. This is the main CLI prompt, and it is where you invoke most of the primary commands for navigating a TeamForge site. When you use go to move to an object such as a document or a tracker artifact, the prompt changes to show the object you are now viewing.

ctf> go artf1234
ctf/artf1234>

ctf> go tracker1305
ctf/tracker1305> items
ctf/tracker1305/items(100)>

ctf> go tracker1305 items
ctf/tracker1305/items(100)>

ctf> go tracker1305 items where status eq "Open"
ctf/tracker1305/items(10)>
ctf>

The prompt adds a layer every time you go deeper into a project and its tools. To leave an object and return to the previous level, press Enter.

Chaining Commands​

At each level of the CLI you can issue more commands to find information about the current object or list, or to perform other actions. When you want to jump straight to a tool or feature, chain the commands together.

Chained commands take you directly to the result rather than stepping you through each level. This also means that when you leave the level you jumped to, you return to where you started instead of stepping back one level at a time.

How to Quit​

No matter where you are in the CLI, type quit to exit. The quit command is a global command, so it runs at any CLI prompt.

Command Levels and Types​

At any point in the CLI you have access to two groups of commands, Global Commands and Current Mode Commands.

A global command can be used at any CLI prompt. Examples include quit, echo, and help.

Current Mode Commands work only at a specific prompt. At the main ctf> prompt these include connect, describe, and server.

Getting Help​

The CLI has a built-in, context-sensitive help system. At any CLI prompt, type help to see the commands currently available. The list shows both the global commands and the current mode options. Only active commands are shown. For example, the index command appears only for users with site administrator permissions.

To see help for a specific command, type help followed by the command name.

ctf> help go
Jump to the specified object

You can also type a question mark (?) for a brief list of the commands currently available.

ctf> ?
api     debug     filters  jump    return  whoami
batch   delete    find     logoff  server  whois
cd      describe  for      my      set
connect echo      go       options shell
ctf     env       help     output  stat
date    eval      history  quit    trace

Quick Navigation Trick​

You do not have to type an entire command name for the CLI to recognize it. Type only enough of the command to make it unique. For example, desc is unique enough in the command list to be treated as if you had typed the whole describe command.

Interacting with TeamForge​

A number of convenience commands help you navigate a project and its contents quickly. This section covers those commands.

ctf> my artifacts
  1) artf4567 [ Open    ]: Create a new Tracker Manager
  2) artf3456 [ Pending ]: Take everyones lunch orders
ctf/list(2)

ctf> my projects where title like labs
  1) proj1437: CollabNet Labs
ctf/list/list(1)> 1
go proj1437
  1) Tracker
  2) Document
  3) Task
  4) Scm
  5) Frs
  6) Wiki
  7) Discussion
  8) Planning Folders
  9) Rbac
 10) Page
 11) News
ctf/list/list/proj1437/list(11)>
tip

A shorter version of my projects where title like labs is my p whe title like labs.

My Workspace​

In TeamForge, the My Workspace page shows a user all the artifacts and tasks assigned to them and awaiting attention. From that page a user can navigate quickly to those assigned objects and see their recent history.

The CLI provides some of the same tools through the my command.

When you use the my command, the CLI auto-navigation feature is enabled. While auto-navigation is enabled, items you select from lists have an auto-navigation command invoked automatically. For example, selecting a project from the my projects list invokes the tools command for that project.

CommandResult
my projectsLists all the projects the current user is a member of.
my artifactsLists all artifacts assigned to the current user site-wide.
my tasksLists all tasks assigned to the current user that have a status of OK.
my historyLists objects recently edited by the current user.

Project Tools​

Use the tools command when you are viewing a project data object. It is also invoked automatically when you choose a project from your my projects list.

ctf> go proj1234 tools

ctf> go proj1234
ctf/proj1234> tools

Before the CLI displays the list of tools, it checks whether the current user has view permission for each tool. A tool appears in the list only if that permission is granted.

When you select a tool, the CLI goes to the top level list of objects in that tool. For example, selecting Tracker shows the list of trackers in that project.