Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

New coapp command line interface

fearthecowboy edited this page Aug 23, 2011 · 15 revisions

CoApp Command line client interface

The CoApp command line client has a simple, yet flexible interface.

When redirecting or piping the results of a CoApp command, the tool will suppress cosmetic formatting and simply list the results of the given command (very useful for chaining the results of one execution into another).

General Usage:

CoApp [options] <command> <parameters>

Commands

All commands are in the form verb-noun (similar to powershell cmdlets) and can be followed by zero or more parameters.

Any commands that takes parameters after the command will accept a list of packages on the command line or via stdin.

List Packages
list-package <pkg-spec>...
Get Package Information
get-packageinfo <pkg-spec>...
Install Package
install-package <pkg-spec>...
Remove Package
remove-package <pkg-spec>...
Update Package
update-package <pkg-spec>...
Trim unused packages
trim 
set package to active
activate-package <pkg-spec>...
Block a package from upgrading
block-package <pkg-spec>...
Unblock a package
unblock-package <pkg-spec>...
Mark a package as 'user requested'
mark-package <pkg-spec>...
Unmark a package as 'user requested'
unmark-package <pkg-spec>...
List Package Feeds
list-feed
Add Package Feed
add-feed <feed-location>...
Remove Package Feed
remove-feed <feed-location>...

Parameters

Specifying packages
<pkg-spec>...

Packages have a canonical name (in the form packagename-##.##.##.##-arch-publickeytoken) which uniquely identifies it apart from other packages. Commands expecting a package name will always take the full canonical name or alternatively, the user can provide a partial name and CoApp will attempt to determine what the user is requesting.

Generally there are three types of inputs that can be specified for the package:

  • a canonical package name (or partial canonical name)
  • a local path (to either a package file or a package directory for use as a package feed )
  • a URL (to either a remote package file, or a package atom feed for use as a package feed )
Specifying package feed locations
<feed-location>...

Generally there are two types of inputs that can be specified for package feeds:

  • a local path (to either a package file or a package directory for use as a package feed )
  • a URL (to either a remote package file, or a package atom feed for use as a package feed )

Options

Clone this wiki locally