package
0.13.1
Repository: https://github.com/axiomhq/cli.git
Documentation: pkg.go.dev

# Functions

AsksForSetup will ask the user to setup Axiom in case it is not yet configured.
ChainRunFuncs chains one or more RunFunc's.
DatasetCompletionFunc returns a completion function which completes the datasets from the configured deployment.
DefaultCompletion sets default values for Args and ValidArgsFunction on all child commands.
FormatCompletion returns a completion function which completes the valid output formats of the `iofmt` package.
InheritRootPersistenPreRun inherits the root commands PersistenPreRunE function down to child commands which specify their own one by chaining them.
NeedsActiveDeployment makes sure an active deployment is configured.
NeedsDatasets prints an error message and errors silently if no datasets are available on the configured deployment.
NeedsDeployments prints an error message and errors silently if no deployments are configured.
NeedsPersonalAccessToken prints an error message and errors silently if the active deployment is not configured with a personal access token.
NeedsRootPersistentPreRunE executes the root commands PersistentPreRunE function.
NeedsValidDeployment prints an error message and errors silently if the given deployment is not configured.
NewFactory creates a new Factory.
NewFlagError returns a new *FlagError wrapping the given error.
NewFlagErrorf returns a new, formatted *FlagError from the given format and arguments.
NoCompletion disables completion.
OrganizationCompletionFunc returns a completion function which completes the organization IDs for the active deployment.
PopulateFromArgs populates the given values with the argumetns given on the command-line.

# Variables

ErrNoPromptArgRequired is raised when the application is not running interactively and thus requires an argument on the command-line instead of prompting for input.
ErrSilent is an error that triggers a non zero exit code without any error message.

# Structs

Factory bundles resources used by most commands.
A FlagError is raised when flag processing fails.

# Type aliases

A CompletionFunc is dynamically invoked without running any of the Run() methods on the cobra.Command.
RunFunc is a cobra run function which is compatible with PersistentPreRunE, PreRunE, RunE, PostRunE and PersistentPostRunE.