beenull/runtipi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

refactor(cli): improve help message for app commands

Browse source
This commit is contained in:
Nicolas Meienberger 2023-10-25 08:16:40 +02:00 committed by Nicolas Meienberger
parent 302f819d02
commit ef0298665c
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/cli/src/index.ts
View file

@ -9,6 +9,8 @@ import { AppExecutors, SystemExecutors } from './executors';
const main = async () => {
program.description(description).version(version);
program.name('./runtipi-cli').usage('<command> [options]');
program
.command('watch')
.description('Watcher script for events queue')
@ -20,7 +22,7 @@ const main = async () => {
program
.command('start')
.description('Start tipi')
.option('--no-permissions', 'Skip permissions check')
.addHelpText('after', '\nExample call: sudo ./runtipi-cli start')
.option('--no-sudo', 'Skip sudo usage')
.action(async (options) => {
const systemExecutors = new SystemExecutors();
@ -73,6 +75,7 @@ const main = async () => {
// Stop app: ./cli app stop <app>
program
.command('app [command] <app>')
.addHelpText('after', '\nExample call: sudo ./runtipi-cli app start <app>')
.description('App management')
.action(async (command, app) => {
const appExecutors = new AppExecutors();