aboutsummaryrefslogtreecommitdiff
path: root/LisaShell.txt
diff options
context:
space:
mode:
authorPatrick Bellasi <patrick.bellasi@arm.com>2016-03-01 21:21:37 +0100
committerPatrick Bellasi <patrick.bellasi@arm.com>2016-03-04 09:57:14 +0000
commit33108ec6c171dd1785d405d1abcf8ff1ca57f39e (patch)
tree2b07f7b357198904fc4843377d18112e27864dd7 /LisaShell.txt
parent945f2ba1700596e5d171890631335ae2332bf947 (diff)
downloadlisa-33108ec6c171dd1785d405d1abcf8ff1ca57f39e.tar.gz
src/shell: add initial support for a LISA shell
The LISA shell provides a set of useful alias and commands for commonly used operations. This intial implementation provides support for: - Submodules update - IPython server start/stop - Results reporting Signed-off-by: Patrick Bellasi <patrick.bellasi@arm.com>
Diffstat (limited to 'LisaShell.txt')
-rw-r--r--LisaShell.txt28
1 files changed, 28 insertions, 0 deletions
diff --git a/LisaShell.txt b/LisaShell.txt
new file mode 100644
index 0000000..23e5b79
--- /dev/null
+++ b/LisaShell.txt
@@ -0,0 +1,28 @@
+
+All LISA Shell commands start with "lisa-", thus using shell completion it is
+easy to get a list of all the available commands.
+
+Here is a list of the main ones, with a short description.
+For a longer description type "lisa-<command> help"
+
+.:: Generic commands
+--------------------
+
+lisa-help - Print this help, or command specific helps
+lisa-version - Dump info on the LISA in use
+
+.:: Maintenance commands
+------------------------
+
+lisa-update - Update submodules and LISA notebooks/tests
+
+.:: Notebooks commands
+----------------------
+
+lisa-ipython - Start/Stop the IPython Notebook server
+
+.:: Results analysis and Documentation
+--------------------------------------
+
+lisa-report - Pretty format results of last test
+