Command line interface reference

search

Search for a pattern and show the results.

beagle search
    [-f {csv,grep,json,link,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--ignore-comments]
    [--comment-marker COMMENT_MARKER]
    [--file FILE_PATTERN]
    [--ignore-case]
    [--repo REPOS]
    [--repo-pattern REPO_PATTERN]
    [--context-lines CONTEXT_LINES]
    query

-f <FORMATTER>, --format <FORMATTER>

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>

when to include quotes, defaults to nonnumeric

--noindent

whether to disable indenting the JSON

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--ignore-comments

ignore comment lines

--comment-marker <COMMENT_MARKER>

start of a comment line

--file <FILE_PATTERN>, --file-pattern <FILE_PATTERN>

file name pattern

--ignore-case

ignore case in search string

--repo <REPOS>

limit search to named repositories (option can be repeated)

--repo-pattern <REPO_PATTERN>

glob pattern to match repository names (filtered on client side)

--context-lines <CONTEXT_LINES>

number of context lines

query

the text pattern

This command is provided by the beagle plugin.