Skip to content

Commit 1ac62bc

Browse files
committed
docs: add sub sections
1 parent 3df19de commit 1ac62bc

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

user_guide_src/source/cli/spark_commands.rst

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ CodeIgniter ships with the official command **spark** and built-in commands.
1212
Running Commands
1313
****************
1414

15-
The commands are run from the command line, in the root directory.
16-
A custom script, **spark** has been provided that is used to run any of the CLI commands::
15+
Running via CLI
16+
===============
17+
18+
The commands are run from the command line, in the project root directory.
19+
The command file **spark** has been provided that is used to run any of the CLI commands::
1720

1821
> php spark
1922

2023
When called without specifying a command, a simple help page is displayed that also provides a list of
21-
available commands. You should pass the name of the command as the first argument to run that command::
24+
available commands.
25+
26+
You should pass the name of the command as the first argument to run that command::
2227

2328
> php spark migrate
2429

@@ -55,9 +60,21 @@ so that you can choose to display it or not.
5560
Using Help Command
5661
******************
5762

58-
You can get help about any CLI command using the help command as follows::
63+
spark help
64+
==========
65+
66+
You can get help about any CLI command using the ``help`` command as follows::
5967

6068
> php spark help db:seed
6169

62-
Use the **list** command to get a list of available commands and their descriptions, sorted by categories.
63-
You may also use ``spark list --simple`` to get a raw list of all available commands, sorted alphabetically.
70+
71+
spark list
72+
==========
73+
74+
Use the ``list`` command to get a list of available commands and their descriptions, sorted by categories::
75+
76+
> php spark list
77+
78+
You may also use the ``--simple`` option to get a raw list of all available commands, sorted alphabetically::
79+
80+
> php spark list --simple

0 commit comments

Comments
 (0)