Invenio-Cli
Command-line tool to create and manage an InvenioRDM instance.
Installation
$ pip install invenio-cli
Usage
Local Development environment
# Initialize environment and cd into <created folder>
$ invenio-cli init rdm
$ cd <created folder>
# Install locally
# install python dependencies (pre-release versions needed for now),
# link/copy assets + statics, install js dependencies, build assets and
# final statics
$ invenio-cli install --pre
# Start and setup services (database, Elasticsearch, Redis, queue)
$ invenio-cli services
# Optional: add demo data
$ invenio-cli demo --local
# Run the server
$ invenio-cli run
# Update assets or statics
$ invenio-cli update
Customizations
It is possible to choose between two python package managers: pipenv and uv. To customize the python package manager it is necessary to add the line python_package_manager = VALUE to the .invenio file in the [cli] section. VALUE is uv or pipenv.
It is possible to choose between two javascript package managers: npm and pnpm. To customize the python package manager it is necessary to add the line javascript_package_manager = VALUE to the .invenio file in the [cli] section. VALUE is npm or pnpm.
It is possible to choose between two assets builders: webpack and rspack. To use rspack add WEBPACKEXT_PROJECT = “invenio_assets.webpack:rspack_project” to the invenio.cfg file.
It is possible to send invenio commands to a long running RPC server instead of starting a new Python process for each command. To enable this add the line use_rpc = true to the [cli] section of the .invenio file. The server listens on a Unix domain socket at <instance_path>/rpc.sock and is started automatically when needed; invenio-cli stops it again on exit.
Containerized ‘Production’ environment
# Initialize environment and cd into <created folder>
$ invenio-cli init rdm
$ cd <created folder>
# Spin-up InvenioRDM
$ invenio-cli containerize
# Optional: add demo data
$ invenio-cli demo --containers
# After updating statics or code, if you do not need to re-install JS
# dependencies which can take time
$ invenio-cli containerize --no-install-js
More Help
# Get more help
$ invenio-cli --help
Further documentation is available on https://invenio-cli.readthedocs.io/
Metadata
Release files for invenio-cli 1.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| invenio_cli-1.13.0.tar.gz | 35.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| invenio_cli-1.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.5 kB
Release files / invenio_cli-1.13.0.tar.gz
| Download URL | invenio_cli-1.13.0.tar.gz |
|---|---|
| Size | 35.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8e9ee801a02fb5efc8fa6516c91b76838f232e98da246fa8973ccf7afb5f7aa6
|
|
BLAKE2b-256 checksum How to use checksums |
67de3549f75e87109cdfd6b8ef7b4c56ba1dc83e1bf4b0d560f9105f4e6557c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / invenio_cli-1.13.0-py3-none-any.whl
| Download URL | invenio_cli-1.13.0-py3-none-any.whl |
|---|---|
| Size | 53.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a25c6cafc7d933d6597c3b8a7339843807f34b658111886a5ef86fd5580d80bf
|
|
BLAKE2b-256 checksum How to use checksums |
8582088cd0c40454a2e604b1e32a45edd220480bdf6c894e18cf4ecc1755925e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|