Skip to main content

TeamForge CLI

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. The TeamForge CLI Server runs CLI scripts on the TeamForge server as extensions to the platform.

These pages apply to all supported TeamForge versions, so they are maintained outside the versioned documentation.

TeamForge CLI

PageContents
Introduction and Basic NavigationCommand levels, chaining commands, the built-in help system, and the convenience commands for your workspace and project tools.
Working with ListsThe data types the CLI works with and the commands that filter, display, search, order, summarize, and iterate over lists.
Command ReferenceSyntax for each CLI command, covering SOAP and REST API access, connections, filters, variables, output, and site administration.
CookbookSample report scripts for project membership, open artifact summaries, repository listings, and template based graphs.

TeamForge CLI Server

PageContents
CLI Server InstallationSystem requirements, the installation procedure, and the bundled test program that verifies the install.
CLI Server User GuideThe security model scripts run under, how to upload and invoke them, and how to write event handlers and scheduled jobs.
CLI Server Web UIThe web interface for interacting with the CLI Server directly, and how to make it available to users.