Add documentation for Command Line Interface

[iMattPro]

@nickvergessen

[Nicofuma]

to me it looks more like a thing for the user documentation than for the dev documentation because it explains whta you can currently do with the CLI, what are the existing commands, but it doesn't explain how it works, how you can add your own command and what differ from a page with a controller

[michaelcullum]

+1 to @Nicofuma's comments but I think the rationale behind putting it here though is it will be more technical/developer users who will be using the CLI.

[Nicofuma]

we could imagine a section: "dev tools" in which most of these explanations could take place

[iMattPro]

@Nicofuma I intended it to go here https://area51.phpbb.com/docs/dev/31x/index.html because those are nice Docs (and right now docs for phpBB are a mess, all over the place, and impossible to find)

[Nicofuma]

I agree with you, something needs to be decided about the doc: how do we want to manage them, what is the final goal?

[iMattPro]

Looking at the "documentation" folder, I don't know if I want to re-do all of this in XML, nor do I see where it will fit in with those Docs. The "Administration" section I guess, though it is entirely about the ACP.

[michaelcullum]

The other side of this is that we don't have anywhere to display 3.2.x docs yet, and regenerating docs for 3.1.x/3.0.x is presently difficult (I don't even know how... @Marshalrusty @Noxwizard).

And XML is ugly.

I would say because this kind of thing is borderline, it might be easier, and entice more work to be done on dev tools docs, if we put it with developer documentation?

[michaelcullum]

Nice work with the docs btw but doesn't it kind of repeat the help command and list commands built into phpBB's CLI. I'm afraid this might just become out of sync.

[iMattPro]

@michaelcullum Fortunately this is for 3.1.x
It does. But I have encountered too often people who have no idea about the CLI, nor how to actually use it. We have nothing about using it anywhere. This will only become out of sync no more so than any other docs ;)

[michaelcullum]

Except most docs aren't repeated in the code. ;)

I think what might be of more use is a single page that talks about how to use the cli, and includes information about the list and help commands and important things like phpbbcli.php -v

[iMattPro]

@michaelcullum Well, isn't that what the getting started page here is doing?

[iMattPro]

OK, will redo so it's more genralized, and instructs users to use the --help or -h on the various commands to learn about their arguments and options within the CLI rather than documenting them all here.

[michaelcullum]

👍 ❤️

[iMattPro]

Updated

[Nicofuma]

Force ANSI (colors) output
many people will not understand

[iMattPro]

Updated

[michaelcullum]

to a shell (or ssh)

[michaelcullum]

Looks good. Thanks ❤️

[iMattPro]

Updated

[iMattPro]

If anybody has anything to add (or remove) or revise please help out. 👍

[Nicofuma]

👍

[Nicofuma]

thank you