Skip to content

Commit a3513cf

Browse files
authored
Merge pull request #7189 from kenjis/fix-docs-spark_commands.rst
docs: improve spark_commands.rst
2 parents 4110441 + 22c8f21 commit a3513cf

1 file changed

Lines changed: 29 additions & 8 deletions

File tree

user_guide_src/source/cli/spark_commands.rst

Lines changed: 29 additions & 8 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

@@ -33,8 +38,9 @@ You may always pass ``--no-header`` to suppress the header output, helpful for p
3338
For all of the commands CodeIgniter provides, if you do not provide the required arguments, you will be prompted
3439
for the information it needs to run correctly::
3540

36-
> php spark migrate:version
37-
> Version?
41+
> php spark make::controller
42+
43+
Controller class name :
3844

3945
Calling Commands
4046
================
@@ -54,9 +60,24 @@ so that you can choose to display it or not.
5460
Using Help Command
5561
******************
5662

57-
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::
5867

5968
> php spark help db:seed
6069

61-
Use the **list** command to get a list of available commands and their descriptions, sorted by categories.
62-
You may also use ``spark list --simple`` to get a raw list of all available commands, sorted alphabetically.
70+
Since v4.3.0, you can also use the ``--help`` option instead of the ``help`` command::
71+
72+
> php spark db:seed --help
73+
74+
spark list
75+
==========
76+
77+
Use the ``list`` command to get a list of available commands and their descriptions, sorted by categories::
78+
79+
> php spark list
80+
81+
You may also use the ``--simple`` option to get a raw list of all available commands, sorted alphabetically::
82+
83+
> php spark list --simple

0 commit comments

Comments
 (0)