Skip to content

XIVY-16914 link engine.cli manpages #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

XIVY-16914 link engine.cli manpages #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81185e8
XIVY-16914 refactor: rename to engine-cli
ivy-rew Jun 2, 2025
235f52c
XIVY-16914 link manpages of the engineCli
ivy-rew Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/engine-guide/configuration/system-database/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The following database management systems are supported, choose one:
mssql
oracle

Use the :ref:`setup-wizard` or the :ref:`engine-config-cli` to create the system
Use the :ref:`setup-wizard` or the :ref:`engine-cli` to create the system
database. To run the Axon Ivy Engine with a system database, a :ref:`license
<license>` is required.

Expand Down
11 changes: 9 additions & 2 deletions ...ine-guide/reference/engine-config-cli.rst → ...gine-guide/reference/engine-cli/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _engine-config-cli:
.. _engine-cli:

EngineConfigCli
EngineCli
===============

The console program is used to configure the Axon Ivy Engine, i.e., to configure,
Expand All @@ -15,3 +15,10 @@ create or convert the system database.
+----------------+------------------------------------------------------------------------+
| <command> help | Get help to a specific command e.g., ``EngineConfigCli config-db help``|
+----------------+------------------------------------------------------------------------+

The concrete commands and descriptions can be found in our manpages:

.. toctree::
:maxdepth: 1

manpages/EngineConfigCli
6 changes: 6 additions & 0 deletions source/engine-guide/reference/engine-cli/manpages/EngineConfigCli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _engine-cli-manpages:

EngineCli Manpages
======================

This is just an placeholder and will be replaced with the manpages.
2 changes: 1 addition & 1 deletion source/engine-guide/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Reference
:maxdepth: 2

axonivy-engine/index
engine-config-cli
engine-cli/index
setup-wizard
migration-wizard
engine-cockpit/index
Expand Down
2 changes: 1 addition & 1 deletion source/engine-guide/reference/setup-wizard.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ license and the creation of a system database.
from the wizard to the :ref:`ivy-yaml` file.

Advanced users might prefer to manually craft configurations in :ref:`ivy-yaml` and
use the :ref:`engine-config-cli` to roll out an Axon Ivy Engine into production.
use the :ref:`engine-cli` to roll out an Axon Ivy Engine into production.
Configuration files make the installation process quickly reproducable in
various environments such as dev, test and prod.

Expand Down
Loading