The RePoSyD Command Line interface (CLI) allows you to manage RePoSyD on your computer. You can prepare an installation to run RePoSyD as an operating server or run RePoSyD without installing a web server or reverse proxy.

C:\> reposyd
  ____           ____            ____            ____  
 |  _ \    ___  |  _ \    ___   / ___|   _   _  |  _ \ 
 | |_) |  / _ \ | |_) |  / _ \  \___ \  | | | | | | | |
 |  _ <  |  __/ |  __/  | (_) |  ___) | | |_| | | |_| |
 |_| \_\  \___| |_|      \___/  |____/   \__, | |____/ 
                                         |___/         
Usage: reposyd [options] [command]

Options:
  -V, --version                 output the version number
  -h, --help                    display help for command

Commands:
  info                          Displays system information
  project                       Manage projects, e.g. create new project, open or close existing projects...
  repository                    Create new or manage existing repositories
  service                       Manage RePoSyD as a Windows Service
  install [options] <folder>    create a @reposyd/service instance
  apiserver [options]           Starts the RePoSyD REST API server
  webserver [options] [folder]  starts the Web Application (https) Server
  help [command]                display help for command

See help for any command:

C:\> reposyd [command] --help

Basically, both programs provide the same commands, but may differ in terms of the version of the ‘@reposyd/service’ package used.

reposyd

The 'reposyd' command-line interface is useed for installing RePoSyD instances and is available globally.

C:\> reposyd help
 ____           ____            ____            ____  
 |  _ \    ___  |  _ \    ___   / ___|   _   _  |  _ \ 
 | |_) |  / _ \ | |_) |  / _ \  \___ \  | | | | | | | |
 |  _ <  |  __/ |  __/  | (_) |  ___) | | |_| | | |_| |
 |_| \_\  \___| |_|      \___/  |____/   \__, | |____/ 
                                         |___/         
Usage: reposyd [options] [command]

The Command Line Interface (CLI) for managing RePoSyD installations.
...

reposyd-cli

The “reposyd-cli” command-line interface is used to manage a RePoSyD instance and can only be used in the “service” directory of the respective RePoSyD instance.

C:\reposyd> .\reposyd-cli help
  ____           ____            ____            ____             ____   _       ___
 |  _ \    ___  |  _ \    ___   / ___|   _   _  |  _ \           / ___| | |     |_ _|
 | |_) |  / _ \ | |_) |  / _ \  \___ \  | | | | | | | |  _____  | |     | |      | |
 |  _ <  |  __/ |  __/  | (_) |  ___) | | |_| | | |_| | |_____| | |___  | |___   | |
 |_| \_\  \___| |_|      \___/  |____/   \__, | |____/           \____| |_____| |___|
                                         |___/
Usage: reposyd-cli [options] [command]

The Command Line Interface (CLI) for managing a RePoSyD instance.
...

RePoSyD CLI is installed as a global package from the RePoSyD registry unsing YARN.

Open a command prompt (or PowerShell), and enter the following:

C:\> yarn config set registry https://pkg.reposyd.de/registry global add @reposyd/cli

Run the installation again to update reposyd to the latest version. See chapter "Installing the RePoSyD CLI" for more information.

$ reposyd info -h
Usage: reposyd info [options]

displays system information

Options:
  -h, --help  display help for command

Example

$ reposyd info
Operating System - Windows_NT (10.0.26200 - win32/x64 )
Platform -  win32
NodeJs - v20.20.2

Networking
  Host PAPA3
  WLAN 2 192.168.178.196
  Loopback Pseudo-Interface 1 127.0.0.1
  vEthernet (Default Switch) 172.29.96.1

RePoSyD Service
  working directory  C:\Testrange\Installation\VM\service
  configuration file C:\Testrange\Installation\VM/data/config/reposyd.json

Environment Variables
  REPOSYD_APPHOST         not set
  REPOSYD_CONFIG          C:\Testrange\Installation\VM/data/config/reposyd.json
  REPOSYD_LOG             not set
  REPOSYD_LOGLEVEL        not set
  REPOSYD_TEMPLATES_EMAIL not set
  REPOSYD_URL             not set
  REPOSYD_PASSWD          not set

Modules
  global  C:\Users\marti\AppData\Roaming\npm\node_modules
  local   C:\RePoSyD\Entwicklung\reposyd-service\node_modules

Packages
  @reposyd/service      5.19.2 C:\Testrange\Installation\VM\service\node_modules\@reposyd\service
  @reposyd/service-core 4.4.1  C:\Testrange\Installation\VM\service\node_modules\@reposyd\service-core
  @reposyd/templates    5.4.1  C:\Testrange\Installation\VM\service\node_modules\@reposyd\templates

Local Project Templates (./templates/projects)
 standard template: not found

The install command allows you to create new instances or updating existing instances of RePoSyD

$ reposyd install -h

Usage: reposyd install [options] [command]

manage the installation of the RePoSyD Service and RePoSyD Web Application

Options:
  -h, --help                   display help for command

Commands:
  check [options] [version]    checks if updates are available for RePoSyD packages
  instance [options] <folder>  install a @reposyd/service instance
  update [options] [version]   updates the latest versions of the RePoSyD packages
  help [command]               display help for command

The check command checks whether updates are available for the RePoSyD instance. Without any additional parameters, the version branch defaults to `patch`.

If version 5.19.1 of the @reposyd/service package is installed in the instance, the command searches for newer versions within the 5.19 branch.

You can use the [version] argument to specify the version branch against which the versions in the instance should be checked.

• patch Checks whether patches are available for the installed version.
• minor Checks whether minor updates are available for the installed version.
• latest Checks whether major or minor updates are available for the installed version.

$ reposyd check -h
Usage: reposyd install check [options] [version]

checks if updates are available for RePoSyD packages

Arguments:
  version     version branch for the update (choices: "latest", "minor", "patch", default: "patch")

Options:
  --registry <registry>  sets the url of the RePoSyD registry (default: "https://registry.reposyd.de/")
  -h, --help  display help for command

Examples

In this example, a patch is available for the @reposyd/service project.

$ reposyd install check
@reposyd/app       5.6.5    up to date
@reposyd/service   5.19.1 → 5.19.2
@reposyd/templates 5.2.1 → 5.2.9

In this example, a patch is available for the @reposyd/service package and a minor update is available for the @reposyd/templates package.

$ reposyd install check minor
@reposyd/app       5.6.5    up to date
@reposyd/service   5.19.1 → 5.19.2
@reposyd/templates 5.2.1  → 5.4.1

The instance command installs a new RePoSyD instance in the specified root folder.

$ reposyd install instance -h
Usage: reposyd install instance [options] <folder>

install a @reposyd/service instance

Arguments:
  folder                     root folder

Options:
  -d,--database <database>   name of the database (default: "reposyd.sqlite")
  -f,--force                 overwrite existing files and folders (default: false)
  --registry <registry>      sets the url of the RePoSyD registry (default: "https://registry.reposyd.de/")
  --skipinstall              skips the installation of the packages required to run the service (default: false)
  --linkpackages             links the requires @reposyd packages instead of adding them (default: false)
  -u, --user                 name of the admin user
  -p, --password <password>  asks for or sets the admin password
  --port <port>              sets REST API server port in the configuration file (default: 3000)
  --noproject                no project is created (default: false)
  --verbose                  displays detailed processing information (default: false)
  -h, --help                 display help for command

The update command updates the RePoSyD instance to the latest versions of the packages. Without further specifications, the minor version branch is used for the updates.

Without specifying the ‘–install’ option, only the required packages for @reposyd/app and the version numbers of the packages in the ‘package.json’ file are updated. The installation must then be performed manually.

If the ‘–install’ option is specified, the packages are installed.

$ reposyd install update -h
Usage: reposyd install update [options] [version]

updates the latest versions of the RePoSyD packages

Arguments:
  version     version branch for the update (choices: "latest", "minor", "patch", default: "patch")

Options:
  --force     overwrites existing files and folders (default: true)
  --install   installs the updates (default: false)
  --registry <registry>  sets the url of the RePoSyD registry (default: "https://registry.reposyd.de/")
  --verbose   displays detailed processing information (default: false)
  -h, --help  display help for command

$ reposyd project -h
Usage: reposyd project [options] [command]

manage projects, e.g. create new project, open or close existing projects...

Options:
  -h, --help                                  display help for command

Commands:
  add [options] <name> [template]             adds a new project to the repository
  list [options]                              lists all projects in the repository
  status [options] <id> [status]              returns or sets the project status
  settings [options] <project> <key> [value]  returns or sets project settings
  help [command]                              display help for command

$ reposyd project add -h
Usage: reposyd project add [options] <name> [template]

adds a new project to the repository

Arguments:
  name                       name of the new project
  template                   name of template used for the creation of the project (default: "standard")

Options:
  -p, --password <password>  admin user password to be set
  --silent                   suppresses all outputs (default: false)
  -u, --user <name>          account name of the admin user (default: "admin")
  --url <url>                URL of the repository. If not specified, env variable REPOSYD_URL is used as default
  --verbose                  displays detailed processing information (default: false)
  -h, --help                 display help for command

$ reposyd project list -h
Usage: reposyd project list [options]

lists all projects in the repository

Options:
  -p, --password <password>  admin user password to be set
  --silent                   suppresses all outputs (default: false)
  --user <name>              name of the admin user (default: "admin")
  --url <url>                url of the repository. If not specified, env variable REPOSYD_URL is used as default
  --verbose                  displays detailed processing information (default: false)
  -h, --help                 display help for command

$ reposyd project settings -h
Usage: reposyd project settings [options] <project> <key> [value]

returns or sets project settings

Arguments:
  project                    name or uuid of the project
  key                        key of the value
  value                      value to be set

Options:
  -p, --password <password>  admin user password to be set
  --silent                   suppresses all outputs (default: false)
  --user <name>              name of the admin user (default: "admin")
  --url <url>                url of the repository. If not specified, env variable REPOSYD_URL is used as default
  --file                     if option is set argument key contains the file name that contains the settings and
                             argument value is ignored.
  --force                    overwrites existing an value
  -h, --help                 display help for command

$ reposyd project status -h
Usage: reposyd project status [options] <id> [status]

returns or sets the project status

Arguments:
  id                         name or uuid of the project
  status                     new project status (choices: "archived", "locked", "open")

Options:
  -p, --password <password>  admin user password to be set
  --silent                   suppresses all outputs (default: false)
  --user <name>              name of the admin user (default: "admin")
  --url <url>                url of the repository. If not specified, env variable REPOSYD_URL is used as default
  -h, --help                 display help for command

$ reposyd repsitory -h
Usage: reposyd repository [options] [command]

create new or manage existing repositories

Options:
  -h, --help               display help for command

Commands:
  init [options] <folder>  initializes a repository
  help [command]           display help for command

$ reposyd repsitory init -h
Usage: reposyd repository init [options] <folder>

initializes a repository

Arguments:
  folder                     path to the folder containing the database

Options:
  --database <database>      name of the database (default: "reposyd.sqlite")
  --force                    overwrite existing files and folders (default: false)
  -p, --password <password>  admin user password to be set
  --silent                   suppresses all outputs (default: false)
  -u, --user                 name of the admin user
  --verbose                  displays detailed processing information (default: false)
  -h, --help                 display help for command

$ reposyd server -h
Usage: reposyd server [options] [command]

starts the RePoSyD REST API or Web Application Server

Options:
  -h, --help      display help for command

Commands:
  start           starts the RePoSyD REST API or Web Application Server
  help [command]  display help for command

$ reposyd server start -h
Usage: reposyd server start [options] [command]

starts the RePoSyD REST API or Web Application Server

Options:
  -h, --help              display help for command

Commands:
  api [options]           Starts the RePoSyD REST API server
  web [options] [folder]  starts the RePoSyD Web Server
  help [command]          display help for command

The server start api command starts the RePoSyD REST API server.

$ reposyd server start api -h
Usage: reposyd server start api [options]

Starts the RePoSyD REST API server

Options:
  --cluster [instances]  Starts a cluster with [instances] of the RePoSyd REST API server
  --silent               suppresses all outputs (default: false)
  -h, --help             display help for command

The server start web command starts the RePoSyD web server.

$ reposyd server start web -h
Usage: reposyd server start web [options] [folder]

starts the RePoSyD Web Server

Arguments:
  folder                 path to the web application folder

Options:
  --port <port>          https server port (default: 443)
  --redirect <redirect>  redirect api requests (default: "http://localhost:3000")
  --silent               suppresses all outputs (default: false)
  -h, --help             display help for command

$ reposyd service -h
Usage: reposyd service [options] [command]

manage RePoSyD as a Windows Service

Options:
  -h, --help                    display help for command

Commands:
  install [options] <folder>    installs the service
  uninstall [options] <folder>  uninstalls the service
  help [command]                display help for command

$ reposyd service install -h
Usage: reposyd service install [options] <folder>

installs the service

Arguments:
  folder                 path to the root folder containing the RePoSyD service installation

Options:
  --account <account>
  --domain <domain>      sets the domain name. Default is the local computer name
  --name <name>          name of the service (default: "RePoSyD-Services")
  --password <password>
  --script <script>      name of the script to run as a Windows service (default: "index.js")
  -h, --help             display help for command

$ reposyd service uninstall -h
Usage: reposyd service uninstall [options] <folder>

uninstalls the service

Arguments:
  folder                 path to the root folder containing the RePoSyD service installation

Options:
  --account <account>
  --domain <domain>      sets the domain name. Default is the local computer name
  --name <name>          name of the service (default: "RePoSyD-Services")
  --password <password>
  --script <script>      name of the script to run as a Windows service (default: "index.js")
  -h, --help             display help for command