Skip to content

Command-Line Interface#

rspm#

RStudio Package Manager

Synopsis#

RStudio Package Manager administrative toolset.

rspm [flags]

Options#

  -c, --config string          Path to config file
  -h, --help                   help for rspm
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output
  -V, --version                Show version number and quit

rspm add#

Command to add packages to sources. Supports remote use with API tokens when enabled.

rspm add [flags]

Examples#

  rspm add --source=[source name] --path=[package path] --replace
  rspm add --source=[source name] --path=[package path 1,package path 2,...]
  rspm add --source=[source name] --file-in=[packages.csv]
  rspm add --source=[curated-cran source name] --packages=[package1,package2,...] --include-suggests
  rspm add --source=[curated-cran source name] --packages=[package1,package2,...] --csv-out=[csvFileName.csv]
  rspm add --source=[curated-cran source name] --file-in=[csvInput.txt]
  rspm add --source=[curated-cran source name] --packages=[package1,package2,...] --snapshot=[snapshot-date] --commit

Options#

  -a, --address string             The address of the remote server. If not specified, the PACKAGEMANAGER_ADDRESS environment variable is used.
      --commit                     Commit the changes. Requires the --snapshot flag.
      --csv-out string             Output the package list to a CSV file at this path. For curated-cran sources.
      --file-in string             The path to a file containing the packages to import. The file format is one package name per line, no column headers. For curated-cran and local sources.
  -h, --help                       help for add
      --include-suggests           Include suggested packages. Defaults to 'false'. For curated-cran sources.
      --insecure-ssl-skip-verify   If true, skip SSL certificate validation. This reduces the security that SSL normally provides.
      --packages strings           A comma-separated list of package names to add from CRAN. For curated-cran sources.
      --path string                A comma-separated list of paths to package files. For local sources.
      --replace                    If a package version or checksum conflict is found, replace the existing package. For local sources.
      --snapshot string            The snapshot date or ID for the package(s) to add. For curated-cran sources.
      --source string              The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm add binary#

Command to add binaries to sources. Supports remote use with API tokens when enabled.

rspm add binary [flags]

Examples#

  rspm add binary --source=[local or git source name] --distribution=centos7 --path=[package path] --replace
  rspm add binary --source=[local or git source name] --distribution=bionic --path=[package path 1,package path 2,...]
  rspm add binary --source=[local or git source name] --distribution=bionic --file-in=[packages.csv]

Options#

      --distribution string   The distribution to use for which the binary was compiled.
      --file-in string        The path to a file containing the packages to import. The file format is one package name per line, no column headers. For curated-cran and local sources.
  -h, --help                  help for binary
      --path string           A comma-separated list of paths to package files. For local sources.
      --replace               If a package version or checksum conflict is found, replace the existing package. For local sources.
      --source string         The name of the source.

Options inherited from parent commands#

  -a, --address string             The address of the remote server. If not specified, the PACKAGEMANAGER_ADDRESS environment variable is used.
  -c, --config string              Path to config file
      --insecure-ssl-skip-verify   If true, skip SSL certificate validation. This reduces the security that SSL normally provides.
  -o, --output-format string       Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                    Provide additional output

rspm archive#

Command to archive a package in a source

Synopsis#

Command to archive a package in a source. Archiving a package will move the current version of a package to the archive while preserving existing versions in the archive. The archived package version will no longer be installed by default, but can still be downloaded from the archive.

rspm archive [flags]

Examples#

  rspm archive --name=[package name] --source=[source name]

Options#

  -h, --help            help for archive
      --name string     The name of the package.
      --source string   The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm clear#

Command to purge source metadata. Cannot be used if any repos are subscribed to the source.

rspm clear [flags]

Examples#

  rspm clear --type=cran
  rspm clear --type=pypi

Options#

      --confirm       Confirms that you understand the actions of this command
  -h, --help          help for clear
      --type string   The type of source. Must be one of 'PyPI', or 'CRAN'. (default "cran")

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm cluster#

Commands for HA/cluster operations

Options#

  -h, --help   help for cluster

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm cluster nodes#

Command to enumerate nodes in a cluster

rspm cluster nodes [flags]

Examples#

  rspm cluster nodes

Options#

  -h, --help   help for nodes

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm cluster offline#

Command to take cluster nodes offline

rspm cluster offline [flags]

Examples#

  rspm cluster offline --timeout=30 --nodes="nodeA,nodeB"

Options#

  -h, --help            help for offline
      --nodes strings   A comma-separated list of cluster host names to take offline.
      --timeout int     The amount of time to wait for node nodes to change. (default 30)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm cluster online#

Command to bring cluster nodes online

rspm cluster online [flags]

Examples#

  rspm cluster online --timeout=30 --nodes="nodeA,nodeB"

Options#

  -h, --help            help for online
      --nodes strings   A comma-separated list of cluster host names to bring online.
      --timeout int     The amount of time to wait for node nodes to change. (default 30)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm completion#

Generate shell autocompletion script

Synopsis#

To load completions:

Bash:

$ source <(rspm completion bash)

# To load completions for each session, execute once: $ echo "source <(rspm completion bash)" >> ~/.bashrc

Note: you may need to install the bash-completion package for your operating system.

rspm completion [bash]

Options#

  -h, --help   help for completion

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm config#

Commands to alter server configuration

Options#

  -h, --help   help for config

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm config debug#

Commands to alter server debug configuration

Options#

  -h, --help   help for debug

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm config debug logger#

Commands to show region status and temporarily [de]activate logging regions

Options#

  -h, --help   help for logger

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm config debug logger activate#

Activate specified log regions and/or show region status

Synopsis#

Activate specified log regions. This applies only to the current server, and not the configuration file.

See the "show" subcommand to list available regions.

rspm config debug logger activate region1 [region2 ...] [flags]

Options#

  -h, --help   help for activate

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm config debug logger deactivate#

Deactivate specified log regions

Synopsis#

Deactivate specified log regions. This applies only to the current server, and not the configuration file.

See the "show" subcommand to list available regions.

rspm config debug logger deactivate region1 [region2 ...] [flags]

Options#

  -h, --help   help for deactivate

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm config debug logger show#

Show log region status

Synopsis#

Show status of log regions. If regions are specified, limit output to only those regions.

rspm config debug logger show [region1 region2 ...] [flags]

Options#

  -h, --help            help for show
      --show-disabled   Show disabled regions in human log output

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm create#

Commands to create entities

Options#

  -h, --help   help for create

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm create git-builder#

Command to create git-builders

rspm create git-builder [flags]

Examples#

  rspm create git-builder --source=[git source name] --url=[URL] --no-wait
  rspm create git-builder --source=[git source name] --url=[URL] --credential=[credential name] --branch=[branch name]
  rspm create git-builder --source=[git source name] --url=[URL] --credential=[credential name] --build-trigger=tags

Options#

      --branch string          Specify the git branch to track for package building. If no branch is provided, it will use the default branch of the repository.
      --build-trigger string   Specify either 'commits' or 'tags'. Defaults to 'commits' (default "commits")
      --credential string      For git-builders with private repos, specify the name of the git credential.
  -h, --help                   help for git-builder
      --no-wait                Do not wait for initial build(s).
      --source string          The name of the source.
      --ssh-key string         For git-builders with private repos, specify the name of the ssh key (deprecated in favor of --credential flag).
      --sub-dir string         Specify the sub directory where the R package is stored.
      --url string             Specify the git URL for package building.
      --wait                   Waits for the initial build(s) and prints helpful information. (default)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm create repo#

Command to create repos

rspm create repo [flags]

Examples#

  rspm create repo --name=[repo name] --description=[text]
  rspm create repo --name=[repo name]
  rspm create repo --name=[repo name] --type=bioconductor --description=[text]
  rspm create repo --name=[repo name] --type=python --description=[text]

Options#

      --description string   Description text. Optional.
  -h, --help                 help for repo
      --name string          The name of the repo or source.
      --type string          Optional. The type of repository. Must be either 'r', 'bioconductor', or 'python'. Defaults to 'r'.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm create source#

Command to create sources

rspm create source [flags]

Examples#

  rspm create source --name=[source name]
  rspm create source --name=[source name] --type=[curated-cran|cran-snapshot|local|git]
  rspm create source --name=[source name] --type=curated-cran --snapshot=2017-11-07
  rspm create source --name=[source name] --type=cran-snapshot --snapshot=2020-07-09
  rspm create source --type=bioconductor --version=3.11

Options#

  -h, --help              help for source
      --name string       The name of the source.
      --snapshot string   The initial CRAN snapshot to use for curated-cran sources. Provide either a transaction id or a snapshot date in yyyy-mm-dd format.
      --type string       Optional. The type of source. Must be one of 'bioconductor', 'curated-cran', 'cran-snapshot', 'local', or 'git'. Defaults to 'local'.
      --version string    The Bioconductor version.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm create token#

Command to create tokens. The token will be written to stdout. Informational messages are written to stderr

rspm create token [flags]

Examples#

  rspm create token --sources=source1,source2 --description="token that never expires"
  rspm create token --sources=* --description="Allows all sources"
  rspm create token --sources=source1,source2 --expires=20d --description="20 day token"
  rspm create token --sources=source1,source2 --expires=5h --description="5 hour token"
  rspm create token --sources=source1,source2 --expires=never --description="token that never expires" --quiet

Options#

      --description string   The description for this token.
      --expires string       The expiry for the token. Provide a value that specifies units in 's', 'm', 'h', or 'd'. A value of 'never' creates a token that never expires. Defaults to 'never' (default "never")
  -h, --help                 help for token
  -q, --quiet                Output the token only.
      --sources strings      A comma-separated list of source names to which this token will be granted access. Only works for Git and Local sources. Use '*' to allow all sources.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm delete#

Commands to delete entities

rspm delete [source|repo|git-builder|ssh-key] [flags]

Examples#

  rspm delete source --name=[source name]
  rspm delete repo --name=[repo name]
  rspm delete ssh-key --name=[key name] (deprecated in favor of git-credential)
  rspm delete git-credential --name=[key name] --type=[ssh|https]
  rspm delete git-builder --name=[git-builder name] --source=[source name]

Options#

  -h, --help            help for delete
      --name string     The name of the repo, source or git-builder to be deleted.
      --source string   For git-builders, specify the name of the source from which to delete.
      --type string     For git-credential, specify the type of key to delete. Only necessary if you have multiple types of keys with the same name.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm edit#

Commands to edit entities

Options#

  -h, --help   help for edit

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm edit git-builder#

Commands to edit git-builder properties

Synopsis#

Use to edit an existing git-builder. Note that git-builders must have consistent URL/credentials at all times, so if you would like to change from an SSH URL to an HTTPS url, you must also change the git credential from an ssh key to an https credential in one command. Git credentials may be rotated by creating a new credential and using this edit command to set the existing git-builder to use the new credential.

rspm edit git-builder [flags]

Examples#

  rspm edit git-builder --name=[git-builder name] --source=[git source name] --new-url=[HTTP/SSH URL]
  rspm edit git-builder --name=[git-builder name] --source=[git source name] --new-credential=[credential name]
  rspm edit git-builder --name=[git-builder name] --source=[git source name] --new-branch=[branch name]
  rspm edit git-builder --name=[git-builder name] --source=[git source name] --new-sub-dir=[sub directory path]
  rspm edit git-builder --name=[git-builder name] --source=[git source name] --remove-credential
  rspm edit git-builder --name=[git-builder name] --source=[git source name] --remove-sub-dir

Options#

  -h, --help                    help for git-builder
      --name string             The name of the git-builder.
      --new-branch string       Specify the new git branch to track for package building.
      --new-credential string   For git-builders with private repos, specify the name of a new git credential.
      --new-ssh-key string      For git-builders with private repos, specify the name of a new SSH key. Deprecated in favor of --new-credential
      --new-sub-dir string      Specify the new sub directory where the R package is stored.
      --new-url string          Specify the new git URL for package building.
      --remove-credential       Remove a git credential from a git builder (don't attempt authentication for this builder).
      --remove-sub-dir          Remove the existing sub directory. Use --remove-sub-dir or --remove-sub-dir=true
      --source string           The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm edit repo#

Commands to edit repo name and description

rspm edit repo [flags]

Examples#

  rspm edit repo --name=[repo name] --new-name=[new repo name] --description=[description]
  rspm edit repo --name=[repo name] --clear-description

Options#

      --clear-description    Clear the repo description text.
      --description string   Description text for the repo.
  -h, --help                 help for repo
      --name string          The name of the existing repo.
      --new-name string      The new name of the repo.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm edit source#

Commands to edit source name

rspm edit source [flags]

Examples#

  rspm edit source --name=[source name] --new-name=[new source name]

Options#

  -h, --help              help for source
      --name string       The name of the existing source.
      --new-name string   The new name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm encrypt#

Command to encrypt values to be used in the configuration file.

Synopsis#

Command to encrypt values to be used in the configuration file. The key will be written to stdout.

rspm encrypt [flags]

Examples#

  rspm encrypt

Options#

  -h, --help   help for encrypt

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm evict#

Command to force persistent storage eviction

rspm evict [flags]

Examples#

  rspm evict
  rspm evict --type=sweep

Options#

  -h, --help          help for evict
      --type string   The eviction type. Use 'normal', 'packages' or 'sweep'. (default "normal")

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm hup#

Command to refresh configuration settings that support SIGHUP

rspm hup [flags]

Examples#

  rspm hup

Options#

  -h, --help   help for hup

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm import#

Command to import Git credentials

rspm import [flags]

Examples#

  rspm import --name=[key name] --path=[/path/to/key]
  rspm import --name=[key name] --path=[/path/to/key] --passphrase-path=[/path/to/file]

Options#

  -h, --help                     help for import
      --name string              The name of the SSH or HTTPS authorization key, to reference in RSPM git builder jobs.
      --passphrase-path string   Optional. The path to a file containing the SSH key passphrase. The text in this file may be in plaintext, or it may be encrypted text from the 'rspm encrypt' command.
      --path string              The path to the SSH key file

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm import https-credential#

Command to import HTTPS credentials

rspm import https-credential [flags]

Examples#

  rspm import https-credential --name=[credential name] --username=[username] --password=[password]

Options#

  -h, --help              help for https-credential
      --password string   The HTTPS credential password or personal access token (PAT). This may be entered in plaintext, or first encrypted using the 'rspm encrypt' command.
      --username string   The HTTPS credential username.

Options inherited from parent commands#

  -c, --config string          Path to config file
      --name string            The name of the SSH or HTTPS authorization key, to reference in RSPM git builder jobs.
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm import ssh-key#

Command to import SSH keys

rspm import ssh-key [flags]

Examples#

  rspm import ssh-key --name=[key name] --path=[/path/to/key]
  rspm import ssh-key --name=[key name] --path=[/path/to/key] --passphrase-path=[/path/to/file]

Options#

  -h, --help                     help for ssh-key
      --passphrase-path string   Optional. The path to a file containing the SSH key passphrase. The text in this file may be in plaintext, or it may be encrypted text from the 'rspm encrypt' command.
      --path string              The path to the SSH key file

Options inherited from parent commands#

  -c, --config string          Path to config file
      --name string            The name of the SSH or HTTPS authorization key, to reference in RSPM git builder jobs.
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm info#

Command to print information about sources and repos

rspm info [flags]

Examples#

  rspm info --source=[source name]
  rspm info --repo=[repo name]

Options#

  -h, --help            help for info
      --repo string     The name of the repo.
      --source string   The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list#

Commands to list entities. See available subcommands. Use without any arguments to list all repos and sources.

rspm list [flags]

Examples#

  rspm list
  rspm list sources
  rspm list packages

Options#

  -h, --help   help for list

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list bioconductor#

Command to list Bioconductor versions

rspm list bioconductor versions [flags]

Examples#

  rspm list bioconductor versions
    - List available Bioconductor versions

Options#

  -h, --help   help for bioconductor

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list cran#

Command to list CRAN snapshots

rspm list cran snapshots [flags]

Examples#

  rspm list cran snapshots --count=100 --page=1
    - List available CRAN snapshots

Options#

      --count int   The number of CRAN snapshots to list per page. (default 100)
  -h, --help        help for cran
      --page int    The page or offset to use. (default 1)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list distributions#

Command to list binary distributions

rspm list distributions [flags]

Examples#

  rspm list distributions
    - List available distributions for binaries

Options#

  -h, --help   help for distributions

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list git-builders#

Command to list git builders

rspm list git-builders [flags]

Examples#

  rspm list git-builders
    - List Git builders globally
  rspm list git-builders --source=[source name]
    - List Git builders for a specified source

Options#

  -h, --help            help for git-builders
      --source string   The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list git-builds#

Command to list Git builds

rspm list git-builds [flags]

Examples#

  rspm list git-builds --source=[source name] --name=[git package name]
    - List the latest Git package build for a specified source and package
  rspm list git-builds --source=[source name] --name=[git package name] --count=1 --page=1
    - List all the Git package builds for a specified source and package

Options#

      --count int       The number of git-builds to list per page. (default 100)
  -h, --help            help for git-builds
      --name string     The name of the git package to search for.
      --page int        The page or offset to use. (default 1)
      --source string   The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list git-credentials#

Command to list git credentials

rspm list git-credentials [flags]

Examples#

  rspm list git-credentials
    - List Git credentials (SSH key and HTTPS credentials) globally

Options#

  -h, --help   help for git-credentials

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list packages#

Command to list packages

rspm list packages [flags]

Examples#

  rspm list packages --repo=[repo name] --search=[search string]
    - List packages for a specified repo with an optional search string
  rspm list packages --repo=[bioc repo name] --version=3.11
    - List packages for a Bioconductor repo
  rspm list packages --source=[source name] --search=[search string]
    - List packages for a specified source with an optional search string

Options#

      --count int        The number of packages to list per page. (default 100)
  -h, --help             help for packages
      --page int         The page or offset to use. (default 1)
      --repo string      The name of the repo for package listing.
      --search string    The search string of a package name to list.
      --source string    The name of the source for package listing.
      --version string   The Bioconductor version to use. For Bioconductor repos only.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list repos#

Command to list repos

rspm list repos [flags]

Examples#

  rspm list repos
    - List repos globally

Options#

  -h, --help   help for repos

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list requirements#

Command to list system requirements

rspm list requirements [flags]

Examples#

  rspm list requirements --repo=[repo name] --packages=[comma-separated list of package names] --distribution=[distribution] --release=[release]
    - List system requirements for a repo and a list of packages

Options#

      --distribution string   The OS distribution for system requirements. One of 'ubuntu', 'redhat', centos', 'opensuse', 'sle'.
  -h, --help                  help for requirements
      --packages string       A comma-separated list of package names for system requirements. Use '*' to list all requirements, but be aware that this could take a while to generate.
      --release string        The OS release for system requirements. '7', or '8' for redhat; '7' for 'centos'; '18.04', '20.04', or '22.04' for ubuntu; '15.3' for opensuse; '15.3' for sle.
      --repo string           The name of the repo.
      --version string        The Bioconductor version to use. For Bioconductor repos only.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list sources#

Command to list sources

rspm list sources [flags]

Examples#

  rspm list sources
    - List sources globally
  rspm list sources --repo=[repo name]
    - List sources for a specified repo

Options#

  -h, --help          help for sources
      --repo string   The name of the repo.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list ssh-keys#

Command to list SSH keys (deprecated)

rspm list ssh-keys [flags]

Examples#

  rspm list ssh-keys (deprecated in favor of git-credentials)
    - List SSH keys globally

Options#

  -h, --help   help for ssh-keys

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm list tokens#

Command to list tokens

rspm list tokens [flags]

Examples#

    rspm list tokens
    - List all API tokens
  rspm list tokens --expired=no
    - List API tokens that have not expired
  rspm list tokens --expired=yes
    - List API tokens that have expired
  rspm list tokens --revoked=yes
    - List revoked API tokens
  rspm list tokens --revoked=no
    - List API tokens that are not revoked
  rspm list tokens --revoked=no --expired=no
    - List only active API tokens (not revoked, not expired)

Options#

      --expired string   Filter for expiration. Use 'yes' to show expired tokens and 'no' to hide them.
  -h, --help             help for tokens
      --revoked string   Filter for revoked status. Use 'yes' to show revoked tokens and 'no' to hide them.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm logs#

Command to retrieve logs for package builds

rspm logs [flags]

Examples#

  rspm logs --transaction-id=6677
  rspm logs --transaction-id=6677 --file-out=output.log

Options#

      --file-out string       Optional. Output to a file at this path.
  -h, --help                  help for logs
      --transaction-id uint   The transaction id for which to retrieve logs.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm offline#

Command to take the service offline

rspm offline [flags]

Examples#

  rspm offline
  rspm offline --timeout=100

Options#

  -h, --help          help for offline
      --timeout int   Seconds to wait for services to stop before forcing offline mode. (default 60)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm online#

Command to return the service to an online state

rspm online [flags]

Examples#

  rspm online

Options#

  -h, --help   help for online

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm remove#

Command to remove packages from sources

rspm remove [flags]

Examples#

    rspm remove package --name=[package name] --source=[source name] --comment=[comment text]
  To remove a package, specify the scope with:
    - [package name]@all to specify all versions
    - [package name]@current to specify the current version
    - [package name]@1.2.3 to specify a version

Options#

      --comment string   A comment to explain the motivation for package removal.
  -h, --help             help for remove
      --name string      The path to the package file.
      --source string    The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm reorder#

Command to reorder repo subscriptions to sources

rspm reorder [flags]

Examples#

  rspm reorder --repo=[repo name] --sources=[source1,source2,source3]
  rspm reorder --repo=[repo name] --sources=[source1] --sources=[source2] --sources=[source3]

Options#

  -h, --help              help for reorder
      --repo string       The name of the repo.
      --sources strings   The names of the sources.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm rerun#

Command to rerun git-builders

rspm rerun git-builder [flags]

Examples#

  rspm rerun git-builder --name=[git package name] --source=[source name]
  rspm rerun git-builder --name=[git package name] --source=[source name] --tag=[tag]

Options#

  -h, --help            help for rerun
      --name string     The name of the git-builder to rerun.
      --no-wait         Do not wait for initial build(s).
      --source string   The name of the source of the git-builder to rerun.
      --tag string      The tag to rerun against.
      --wait            Waits for the build(s) and prints helpful information. (default)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm revoke#

Commands to revoke grants

Options#

  -h, --help   help for revoke

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm revoke token#

Command to revoke tokens

rspm revoke token [flags]

Examples#

  rspm revoke token --guid=09185576-4d37-4049-b16a-bf96b2ed6602
  rspm revoke token --token=[token]

Options#

      --guid string    The GUID of the token to revoke. Required if '--token' is not provided.
  -h, --help           help for token
      --token string   The token to revoke. Required if '--guid' is not provided.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm run#

Command to run git-builders

rspm run git-builder [flags]

Examples#

  rspm run git-builder --name=[git package name] --source=[source name]

Options#

  -h, --help            help for run
      --name string     The name of the git-builder to run.
      --no-wait         Do not wait for initial build(s).
      --source string   The name of the source of the git-builder to run.
      --wait            Waits for the build(s) and prints helpful information. (default)

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm subscribe#

Command to subscribe repos to sources

rspm subscribe [flags]

Examples#

  rspm subscribe --source=[source name] --repo=[repo name]

Options#

  -h, --help            help for subscribe
      --repo string     The name of the repo.
      --source string   The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm sync#

Command to initiate an ad-hoc sync of managed sources such as Bioconductor, CRAN or PyPI

Synopsis#

Command to initiate an ad-hoc sync of of managed sources such as Bioconductor, CRAN or PyPI. The SyncSchedule property in the configuration file can be used for regular syncs.

rspm sync [flags]

Examples#

  rspm sync
  rspm sync --no-wait
  rspm sync --type=bioconductor
  rspm sync --type=bioconductor --source=bioc-3.11
  rspm sync --type=pypi

Options#

  -h, --help            help for sync
      --no-wait         Run the sync without waiting.
      --quiet           Do not show the progress bar while waiting on sync (applies only to PyPI).
      --source string   The Bioconductor source name. Optional for syncing a specific Bioconductor source.
      --type string     Select which source to sync to. Must be either 'CRAN', 'PyPI', or 'Bioconductor'. (default "CRAN")
      --wait            Block until done syncing (default).

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm unsubscribe#

Command to unsubscribe repos from sources

rspm unsubscribe [flags]

Examples#

  rspm unsubscribe --source=[source name] --repo=[repo name]

Options#

  -h, --help            help for unsubscribe
      --repo string     The name of the repo.
      --source string   The name of the source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm update#

Command to update curated-cran sources

rspm update [flags]

Examples#

  rspm update --source=[curated-cran source name]
  rspm update --source=[curated-cran source name] --snapshot=[snapshot date]
  rspm update --source=[curated-cran source name] --snapshot=[snapshot date] --commit

Options#

      --commit            Commit the updates.
      --csv-out string    Output the package list to a CSV file.
  -h, --help              help for update
      --snapshot string   The snapshot date used to locate the packages to update.
      --source string     The name of the curated-cran source.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm url#

Commands for creating and explaining URLs

Options#

  -h, --help   help for url

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm url create#

Command to create a URL identifier

rspm url create [flags]

Examples#

  rspm url create --date=2020-11-06 --repo=all
  rspm url create --repo=cran --snapshot=cran:2020-11-06 --snapshot=local:5566
  rspm url create --repo=all --date=2020-11-06 --snapshot=cran:2020-11-06 --snapshot=local:5566 --lock
  rspm url create --repo=cran --date=2020-11-07 --snapshot=cran:2020-11-06

Options#

      --date string        The date for the URL in YYYY-MM-DD format. Either --date or --snapshot (or both) must be specified.
  -h, --help               help for create
      --lock               Generate a locked URL identifier.
      --repo string        The name of the repo.
      --snapshot strings   The snapshots to use in 'source:snapshot' format. You can specify more than one --snapshot flag. Supports both the YYYY-MM-DD format (for CRAN) or transaction IDs. Either --date or --snapshot (or both) must be specified.

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output

rspm url explain#

Command to explain a URL identifier

rspm url explain [flags]

Examples#

  rspm url explain --url=2020-10-25+Y3JhbjoyMDIxLTAzLTA4LDM6NDM4

Options#

  -h, --help         help for explain
      --url string   URL to explain

Options inherited from parent commands#

  -c, --config string          Path to config file
  -o, --output-format string   Specify the output format 'human' for human-readable output or 'json' for JSON-encoded output. (default "human")
  -v, --verbose                Provide additional output