Command-Line Interface#

rspm [flags]

  -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 [flags]

  rspm add --source=[source name] --path=[package path] --replace
  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

      --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 sources.
  -h, --help               help for add
      --include-suggests   Include suggested packages. Defaults to 'false'. For curated-cran sources.
      --packages strings   A comma-separated list of package names to add from CRAN. For curated-cran sources.
      --path string        The path to the package file. 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.

  -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 archive [flags]

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

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

  -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 [flags]

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

      --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")

  -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

  -h, --help   help for cluster

  -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 [flags]

  rspm cluster nodes

  -h, --help   help for nodes

  -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 [flags]

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

  -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)

  -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 [flags]

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

  -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)

  -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 [bash]

  -h, --help   help for completion

  -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

  -h, --help   help for config

  -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

  -h, --help   help for debug

  -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

  -h, --help   help for logger

  -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 region1 [region2 ...] [flags]

  -h, --help   help for activate

  -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 region1 [region2 ...] [flags]

  -h, --help   help for deactivate

  -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 [region1 region2 ...] [flags]

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

  -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

  -h, --help   help for create

  -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 [flags]

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

      --branch string          Specify the git branch to track for package building. (default "master")
      --build-trigger string   Specify either 'commits' or 'tags'. Defaults to 'commits' (default "commits")
  -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.
      --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)

  -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 [flags]

  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]

      --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'.

  -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 [flags]

  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

  -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.

  -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 [source|repo|git-builder|ssh-key] [flags]

  rspm delete source --name=[source name]
  rspm delete repo --name=[repo name]
  rspm delete ssh-key --name=[key name]
  rspm delete git-builder --name=[git-builder name] --source=[source name]

  -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.

  -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

  -h, --help   help for edit

  -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 [flags]

  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-ssh-key=[SSH key 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-sub-dir

  -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-ssh-key string   For git-builders with private repos, specify the name of a new SSH key.
      --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-sub-dir       Remove the existing sub directory. Use --remove-sub-dir or --remove-sub-dir=true
      --source string        The name of the source.

  -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 [flags]

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

      --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.

  -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 [flags]

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

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

  -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 [flags]

  rspm encrypt

  -h, --help   help for encrypt

  -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 [flags]

  rspm evict
  rspm evict --type=sweep

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

  -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 [flags]

  rspm hup

  -h, --help   help for hup

  -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 [flags]

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

  -h, --help                     help for import
      --name string              The name of the SSH key.
      --passphrase-path string   Optional. The path to a file containing the SSH key passphrase.
      --path string              The path to the SSH key file.

  -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 info [flags]

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

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

  -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|repos|packages|cran|bioconductor|git-builders|ssh-keys|requirements] [flags]

  rspm list sources
    - List sources globally
  rspm list sources --repo=[repo name]
    - List sources for a specified repo
  rspm list repos
    - List repos globally
  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
  rspm list cran snapshots --count=100 --page=1
    - List available CRAN snapshots
  rspm list bioconductor versions
    - List available Bioconductor versions
  rspm list ssh-keys
    - List SSH keys globally
  rspm list git-builders
    - List Git builders globally
  rspm list git-builders --source=[source name]
    - List Git builders for a specified source
  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
  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

      --count int             The number of packages or git-builds to list per page. (default 100)
      --distribution string   The OS distribution for system requirements. One of 'ubuntu', 'redhat', centos', 'opensuse', 'sle'.
  -h, --help                  help for list
      --name string           The name of the git package to search for.
      --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.
      --page int              The page or offset to use when listing packages or git-builds. (default 1)
      --release string        The OS release for system requirements. '7', or '8' for redhat/centos; '16.04', '18.04', or '20.04' for ubuntu; '42.3', '15', or '15.2' for opensuse; '12.3', '15', or '15.2' for sle.
      --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.

  -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 [flags]

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

      --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.

  -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 [flags]

  rspm offline
  rspm offline --timeout=100

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

  -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 [flags]

  rspm online

  -h, --help   help for online

  -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 [flags]

    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

      --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.

  -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 [flags]

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

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

  -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 git-builder [flags]

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

  -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)

  -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 git-builder [flags]

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

  -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)

  -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 [flags]

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

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

  -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 [flags]

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

  -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).

  -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 [flags]

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

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

  -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 [flags]

  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

      --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.

  -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

  -h, --help   help for url

  -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 [flags]

  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

      --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.

  -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 [flags]

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

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

  -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