Inceptum/docs/Commands.md

32 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2022-01-20 18:13:37 +01:00
# CLI
2022-11-03 17:07:55 +01:00
Inceptum provides a CLI which performs similar functions to the GUI. If you have feature requests, [open an issue](https://helpdesk.frohnmeyer-wds.de/issue?repo=Inceptum&owner=JfMods)
2022-01-20 18:13:37 +01:00
To view up-to-date information on the commands provided by Inceptum, run `inceptum help` or `inceptum help <command>`, this page is intended to explain more advanced features
## The inceptum wrapper
2022-09-04 21:21:24 +02:00
2022-01-20 18:13:37 +01:00
Inceptum Wrapper looks through the libraries dir and launches the latest available Inceptum version.
2022-11-03 17:07:55 +01:00
If it doesn't find a usable version, it will download the latest available version automatically.
2022-09-06 16:03:17 +02:00
Launching is performed through a custom ClassLoader and an internal flag is set to inform the launched version about the wrappers' presence.
2022-01-20 18:13:37 +01:00
## The "batch" command
2022-09-04 21:21:24 +02:00
2022-01-20 18:13:37 +01:00
This command will go through every line in the file provided in its arguments and executes the command written there.
It is intended to be used in scripts that only want to run inceptum once, such as the systemd unit in the AUR package.
The batch command has the additional advantage of allowing caches to stay loaded between commands, making execution faster.
2022-01-20 18:13:37 +01:00
For example,
2022-09-04 21:21:24 +02:00
2022-01-20 18:13:37 +01:00
```
2022-09-06 16:03:17 +02:00
mod update all icesrv
2022-01-20 18:13:37 +01:00
run server restart icesrv
2022-09-06 16:03:17 +02:00
run server restart server2
2022-01-20 18:13:37 +01:00
```
2022-09-04 21:21:24 +02:00
2022-01-20 18:13:37 +01:00
is equivalent to the bash script
2022-09-04 21:21:24 +02:00
2022-01-20 18:13:37 +01:00
```shell
#!/bin/sh
2022-09-06 16:03:17 +02:00
inceptum mod update all icesrv
2022-01-20 18:13:37 +01:00
inceptum run server restart icesrv
2022-09-06 16:03:17 +02:00
inceptum run server restart server2
2022-01-20 18:13:37 +01:00
```