invenio-cli 1.9.2
"Invenio module to ease the creation and management of applications."
License: MIT
Requires Python: >=3.7
Keywords: invenio-cli

..
    Copyright (C) 2019-2020 CERN.
    Copyright (C) 2019-2020 Northwestern University.

    Invenio-Cli is free software; you can redistribute it and/or modify
    it under the terms of the MIT License; see LICENSE file for more details.

=================
 Invenio-Cli
=================

.. image:: https://github.com/inveniosoftware/invenio-cli/workflows/CI/badge.svg
        :target: https://github.com/inveniosoftware/invenio-cli/actions?query=workflow%3ACI

.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-cli.svg
        :target: https://coveralls.io/r/inveniosoftware/invenio-cli

.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-cli.svg
        :target: https://github.com/inveniosoftware/invenio-cli/releases

.. image:: https://img.shields.io/pypi/dm/invenio-cli.svg
        :target: https://pypi.python.org/pypi/invenio-cli

.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-cli.svg
        :target: https://github.com/inveniosoftware/invenio-cli/blob/master/LICENSE

Command-line tool to create and manage an InvenioRDM instance.

Installation
============

.. code-block:: console

    $ pip install invenio-cli

Usage
=====

Local Development environment
-----------------------------

.. code-block:: console

    # 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


Containerized 'Production' environment
--------------------------------------

.. code-block:: console

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

.. code-block:: console

    # Get more help
    $ invenio-cli --help

Further documentation is available on https://invenio-cli.readthedocs.io/

..
    Copyright (C) 2019-2024 CERN.
    Copyright (C) 2019-2021 Northwestern University.
    Copyright (C) 2025      TU Wien.
    Copyright (C) 2025 Graz University of Technology.

    Invenio-Cli is free software; you can redistribute it and/or modify
    it under the terms of the MIT License; see LICENSE file for more details.

Changes
=======

Version v1.9.2 (released 2025-08-12)

- cli: pass all values to config_parser as strings

Version v1.9.1 (released 2025-07-28)

- versions: fix pyproject.toml app dependency version detection

Version 1.9.0 (released 2025-07-23)

- cookiecutter: make v13 the default
- readme: fix ci badge
- docs: update CONTRIBUTING.rst w/ modern links/process

Version 1.8.0 (released 2025-07-21)

- update: remove db extra for v13
- local: add custom Jobs Celery Beat scheduler to run commands
- versions: support ref in pipfile
- fix: vi editing_mode when updating instance path

Version 1.7.2 (released 2025-04-22)

- setup: bump minimum version of `pipenv` to pull in the `packaging` dependency

Version 1.7.1 (released 2025-03-31)

- versions: fix accidental creation of a tuple from the version string

Version 1.7.0 (released 2025-03-28)

- build: allow use of either `npm` or `pnpm` as JS package manager (via `.invenio`)

Version 1.6.1 (released 2025-03-27)

- versions: consider `pyproject.toml` when checking `App-{RDM,ILS}` dependency versions

Version 1.6.0 (released 2025-02-28)

- packages: allow use of either `pipenv` or `uv` as python package manager
- flask: replace `FLASK_ENV` with `FLASK_DEBUG`
- celery: allow setting a log level
- config: make host & port for both web and search configurable via `.invenio.private`
- run: introduce more fine-granular "web" and "worker" sub-commands

Version 1.5.0 (released 2024-08-01)

- dependencies: update for invenio-app-rdm v12

Version 1.4.0 (released 2024-07-12)

- services: add support for InvneioILS setup

Version 1.3.1 (released 2024-06-05)

- config: fix missing "instance_path" usage

Version 1.3.0 (released 2024-05-24)

- deps: pin docker to >=7.1.0 due to bug on requests
- services: add instance path to env on setup

Version 1.2.0 (released 2023-10-02)

- reload on invenio.cfg changes

Version 1.1.0 (released 2023-07-24)

- add compatibility for docker compose v2
- consider command errors when using install command and fail

Version 1.0.21 (released 2023-05-18)

- deps: support docker < 7 for compatibility with urllib3 v2

Version 1.0.20 (released 2023-03-134)

- setup: add queues initialisation to steps

Version 1.0.19 (released 2023-03-10)

- global: remove fail message on warning (i.e. soft failures)

Version 1.0.18 (released 2023-02-07)

- containerize: fix translation commands instance path

Version 1.0.17 (released 2023-01-30)

- requirements: check node version depending on app-rdm version

Version 1.0.16 (released 2023-01-30)

- bump cookiecutter to v11.0

Version 1.0.15 (released 2023-01-13)

- Setup: fix empty translation folder failing

Version 1.0.14 (released 2023-01-09)

- Add app-rdm fixtures to setup

Version 1.0.13 (released 2022-11-14)

- Allow compilation command to fail in case of missing catalogs.

Version 1.0.12 (released 2022-10-28)

- Adds support for translations (i18n) management commands.

Version 1.0.11 (released 2022-10-24)

- Add support for InvenioILS

Version 1.0.8 (released 2022-10-13)

- Fix issue when checking for services to be up
  and running correctly.

Version 1.0.7 (released 2022-10-10)

- Fix compat issue with RDM versions < v10

Version 1.0.6 (released 2022-10-10)

- Bump default RDM version.

Version 1.0.5 (released 2022-05-31)

- Bump click version.
- Bump default RDM version.
- Improve error handling.
- Add check for npm version.
- Move ImageMagick check to --development.

Version 1.0.4 (released 2022-02-14)

- Fixes an issue with virtualenv 20.13.1+ brining in setuptools 60.x which is
  incompatible with Celery v5.2.3. Once Celery v5.2.4 has been released, this
  fix is no longer needed.

Version 1.0.3 (released 2022-02-04)

- Added ``--no-input`` and ``--config=`` options to ``init`` to support running
  with predefined config and without requiring user input.

Version 1.0.0 (released 2021-08-05)

- Initial public release.