Enum Commands

pub enum Commands {
    List {
        object: Objects,
        pretty: Formats,
    },
    Config {
        output: Option<String>,
        tag: Option<String>,
        tag_filter: Option<String>,
        ignore_unauthorized: bool,
        no_slug: bool,
        offline: bool,
        progress: bool,
        threads: u8,
    },
    Slug {
        text: Option<String>,
    },
    Get {
        url: String,
        script: Option<(String, String)>,
        output: Option<String>,
        timeout_connect: u16,
        max_time: u16,
        headers: Vec<(String, String)>,
    },
}

Variants

List

List objects found in the compose file: services, volumes, …

Fields

object: Objects

pretty: Formats

Config

Parse, resolve and render compose file in canonical format

Fields

output: Option<String>

Save to file (default to stdout)

tag: Option<String>

output image attributes in services with tag passed instead of the one set in the file if they exist locally or in the remote docker registry

tag_filter: Option<String>

use with –tag to filter which images should be checked whether the tag exists or not locally or remotely. Currently only regex=EXPR or regex!=EXPR are supported

ignore_unauthorized: bool

ignore unauthorized errors from docker when fetching remote tags info

no_slug: bool

Don’t slugify the value from –tag

offline: bool

only check –tag TAG with the local docker registry

progress: bool

outputs in stderr the progress of fetching the tags info, similar to –verbose, but without all the other details –verbose adds

threads: u8

max number of threads used to fetch remote images info

Slug

Outputs a slug version of the text passed, or the slug version of the current branch.

It’s the same slug used with the –tag value in other commands. The output is a lowercase version with all no-alphanumeric characters translated into the “-” symbol, except for the char “.”, to make it compatible with a valid docker tag name.

Fields

text: Option<String>

text to slugify, if not provided the current branch name is used

Get

Download a file from an HTTP URL, if the resource doesn’t exist, fallback to another URL generated editing the URL given with a script provided in the form of “text-to-replace:replacer”.

Fields

url: String

The URL where the file is located

script: Option<(String, String)>

if request to URL responds back with HTTP 404, create a second URL replacing any occurrence of the left part of the script with the right part. Each part of the script has to be separated with the symbol :. E.g. pose get https://server.com/repo/master/compose.yml master:feature-a will try first download the resource from https://server.com/repo/master/compose.yml, if not found, will try at https://server.com/repo/feature-a/compose.yml

output: Option<String>

Save to file (default use the same filename set in the url)

timeout_connect: u16

Maximum time in seconds that you allow pose’s connection to take. This only limits the connection phase, so if pose connects within the given period it will continue, if not it will exit with error.

max_time: u16

Maximum time in seconds that you allow the whole operation to take.

headers: Vec<(String, String)>

HTTP header to include in the request

Trait Implementations

impl FromArgMatches for Commands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand