sztabctl CLI command inconsistency with documentation (SZ-102)

rk@tigase.net opened 1 week ago

Type

Usability / Documentation inconsistency

Severity

Low

Description

The documentation lists the following commands:

./sztabctl start
./sztabctl stop
./sztabctl restart
./sztabctl status
./sztabctl logs

However, the actual CLI expects:

sztabctl --run
sztabctl --down
sztabctl --logs
sztabctl --status
sztabctl --urls

This creates confusion for first-time users attempting to follow the documented examples.

Expected Behavior

The CLI syntax and documentation should be consistent.

Either:

Update the CLI to support verb-style commands (start/stop/restart/status/logs), or
Update the documentation to reflect flag-based usage.

Acceptance Criteria

CLI help output matches README examples
All documented commands execute successfully
No ambiguity in usage

Activities

rk@tigase.net changed state to 'In Progress' 1 week ago
Previous Value Current Value
Open

In Progress
rk@tigase.net removed comment 1 week ago

Previous Value	Current Value
Open	In Progress

rk@tigase.net commented 1 week ago

rksuma@Ramakrishnans-MacBook-Pro sztab % git checkout wolnosc
Already on 'wolnosc'

rksuma@Ramakrishnans-MacBook-Pro sztab % git pull
Your branch is up to date with 'origin/wolnosc'.
Already up to date.
rksuma@Ramakrishnans-MacBook-Pro sztab % git checkout -b release/1.9.2-polish
Switched to a new branch 'release/1.9.2-polish'
rksuma@Ramakrishnans-MacBook-Pro sztab %

rk@tigase.net commented 7 days ago

In 1.9.2
rk@tigase.net changed state to 'Closed' 7 days ago
Previous Value Current Value
In Progress

Closed
Login to comment

Previous Value	Current Value
In Progress	Closed

Type	Bug
Priority	Normal
Assignee	rk@tigase.net
Version	1.9.1
Sprints	n/a
Customer	n/a

Issue Votes (0)

Watchers (3)

Reference

SZ-102