Metadata-Version: 2.4
Name: invenio-cli
Version: 1.12.2
Summary: Invenio module to ease the creation and management of applications.
Project-URL: Repository, https://github.com/inveniosoftware/invenio-cli
Author-email: CERN & Northwestern University <info@inveniosoftware.org>
License-Expression: MIT
License-File: AUTHORS.rst
License-File: LICENSE
Keywords: invenio-cli
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.8
Requires-Dist: babel>=2.8
Requires-Dist: click-default-group>=1.2.2
Requires-Dist: click>=7.1.1
Requires-Dist: cookiecutter>=2.0.0
Requires-Dist: docker>=7.1.0
Requires-Dist: pipenv>=2024.0.3
Requires-Dist: pipfile>=0.0.2
Requires-Dist: pynpm>=0.3.0
Requires-Dist: pyyaml>=5.1.2
Requires-Dist: tomli>=1.1.0; python_version < '3.11'
Requires-Dist: virtualenv>=20.0.35
Provides-Extra: tests
Requires-Dist: pytest-black>=0.6.0; extra == 'tests'
Requires-Dist: pytest-invenio>=1.4.0; extra == 'tests'
Requires-Dist: sphinx>=4.2.0; extra == 'tests'
Description-Content-Type: text/x-rst

..
    SPDX-FileCopyrightText: 2019-2020 CERN.
    SPDX-FileCopyrightText: 2019-2020 Northwestern University.
    SPDX-License-Identifier: MIT

=================
 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/
