Zero Install .NET API  2.18.0
Namespaces | Classes | Enumerations
ZeroInstall.Commands Namespace Reference

Command-line interface for Zero Install. Both an actual CLI and a library for building other clients. NuGet: ZeroInstall.Commands More...

Namespaces

namespace  Basic
 Basic set of CLI commands that work cross-platform.
 
namespace  Desktop
 CLI commands that require desktop integration functionality.
 

Classes

class  CliCommand
 Represents a command invoked via command-line arguments. More...
 
class  CliCommandHandler
 Uses the stdin/stderr streams to allow users to interact with CliCommands. More...
 
class  CliMultiCommand
 Common base class for commands that provide multiple sub-CliCommands. More...
 
interface  ICliSubCommand
 Interface for CliCommands that are aggregated by a CliMultiCommand. More...
 
interface  ICommandHandler
 Callback methods to allow users to interact with CliCommands. More...
 
class  NeedsGuiException
 Indicates that the requested operation requires a GUI but the current process does not have one. More...
 
class  Program
 A command-line interface for Zero Install, for installing and launching applications, managing caches, etc. More...
 
class  ProgramUtils
 Provides utility methods for application entry points. More...
 
class  ScopedOperation
 Common base class for Zero Install operations that require scoped dependency resolution. More...
 
class  UnsuitableInstallBaseException
 Indicates that the current Locations.InstallBase is unsuitable for the desired operation. More...
 
class  ZeroInstallInstance
 Provides information about the currently running instance of Zero Install. More...
 

Enumerations

enum  ConfigTab {
  Default, Updates, Storage, Catalog,
  Trust, Sync, Language, Advanced
}
 Available tabs in a Config GUI. More...
 
enum  ExitCode {
  ExitCode.OK = 0, ExitCode.NoChanges = 1, ExitCode.WebError = 10, ExitCode.AccessDenied = 11,
  ExitCode.IOError = 12, ExitCode.SolverError = 20, ExitCode.ExecutorError = 21, ExitCode.InvalidData = 25,
  ExitCode.DigestMismatch = 26, ExitCode.InvalidSignature = 27, ExitCode.NotSupported = 50, ExitCode.InvalidArguments = 99,
  ExitCode.UserCanceled = 100
}
 An exit code is returned to the original caller after the application terminates, to indicate success or the reason for failure. More...
 

Detailed Description

Command-line interface for Zero Install. Both an actual CLI and a library for building other clients. NuGet: ZeroInstall.Commands

Enumeration Type Documentation

◆ ConfigTab

Available tabs in a Config GUI.

◆ ExitCode

An exit code is returned to the original caller after the application terminates, to indicate success or the reason for failure.

Enumerator
OK 

The operation completed without any problems.

NoChanges 

The operation resulted in no changes. This may be due to a problem with the input or simply indicate that the system is already in the desired state.

WebError 

There was a network problem. This may be intermittent and resolve itself e.g. when a Wi-Fi connection is restored.

See also
WebException
AccessDenied 

You have insufficient access rights. This can potentially be fixed by running the command as an Administrator/root. It may also indicate misconfigured file permissions.

See also
UnauthorizedAccessException
IOError 

There was an IO problem. This encompasses issues such as missing files or insufficient disk space.

See also
IOException
SolverError 

The ISolver was unable to provide Selections that fulfill the Requirements. This can be caused by a problem with the feed, an impossible request (e.g., non-existing version) or your local configuration.

See also
SolverException
ExecutorError 

The IExecutor was unable to launch the desired application. This usually indicates a problem with the feed.

See also
ExecutorException
InvalidData 

A data file could not be parsed. This encompasses issues such as damaged configuration files or malformed XML documents (e.g. feeds).

See also
InvalidDataException
DigestMismatch 

The ManifestDigest of an implementation does not match the expected value. This could be caused by a damaged download or an incorrect feed.

See also
DigestMismatchException
InvalidSignature 

There was a problem with the digital signature of a feed. The signature may be missing, damaged or not trusted for the source the feed came from.

See also
SignatureException
NotSupported 

The operation could not be completed because a feature that is not (yet) supported was requested. Upgrading to a newer version may resolve this issue.

See also
NotSupportedException
InvalidArguments 

The command-line arguments passed to the application were invalid.

See also
OptionException, FormatException
UserCanceled 

The user canceled the task.

See also
OperationCanceledException