laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/35387?usp=email )
Change subject: docs/shell: extend the introduction part; link to video presentation
......................................................................
docs/shell: extend the introduction part; link to video presentation
Change-Id: I77c30921f2b8c002c9dda244656c348c96b41f06
---
M docs/shell.rst
1 file changed, 30 insertions(+), 2 deletions(-)
Approvals:
fixeria: Looks good to me, but someone else must approve
Jenkins Builder: Verified
laforge: Looks good to me, approved
diff --git a/docs/shell.rst b/docs/shell.rst
index d8c0967..313d6d9 100644
--- a/docs/shell.rst
+++ b/docs/shell.rst
@@ -4,7 +4,9 @@
pySim-shell is an interactive command line shell for all kind of interactions with SIM cards,
including classic GSM SIM, GSM-R SIM, UICC, USIM, ISIM, HPSIM and recently even eUICC.
-The interactive shell provides command for
+If you're familiar with Unix/Linux shells: Think of it like *the bash for SIM cards*.
+
+The pySim-shell interactive shell provides commands for
* navigating the on-card filesystem hierarchy
* authenticating with PINs such as ADM1
@@ -16,14 +18,31 @@
* decoded reading (display file data represented in human and machine readable JSON format)
* decoded writing (encode from JSON to binary format, then write)
+* if your card supports it, and you have the related privileges: resizing, creating, enabling and disabling of
+ files
+
By means of using the python ``cmd2`` module, various useful features improve usability:
* history of commands (persistent across restarts)
* output re-direction to files on your computer
-* output piping through external tools like 'grep'
+* output piping through external tools like ``grep``
* tab completion of commands and SELECT-able files/directories
* interactive help for all commands
+A typical interactive pySim workflow would look like this:
+
+* starting the program, specifying which smart card interface to use to talk to the card
+* verifying the PIN (if needed) or the ADM1 PIN in case you want to write/modify the card
+* selecting on-card application dedicated files like ADF.USIM and navigating the tree of DFs
+* reading and potentially modifying file contents, in raw binary (hex) or decoded JSON format
+
+Video Presentation
+------------------
+
+There is a `video recording of the presentation back when pySim-shell was originally released
+<https://media.ccc.de/v/osmodevcall-20210409-laforge-pysim-shell>`_. While it is slightly dated, it should
+still provide a good introduction.
+
Running pySim-shell
-------------------
--
To view, visit https://gerrit.osmocom.org/c/pysim/+/35387?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: pysim
Gerrit-Branch: master
Gerrit-Change-Id: I77c30921f2b8c002c9dda244656c348c96b41f06
Gerrit-Change-Number: 35387
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: merged
laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35387?usp=email )
Change subject: docs/shell: extend the introduction part; link to video presentation
......................................................................
Patch Set 1: Code-Review+2
--
To view, visit https://gerrit.osmocom.org/c/pysim/+/35387?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: pysim
Gerrit-Branch: master
Gerrit-Change-Id: I77c30921f2b8c002c9dda244656c348c96b41f06
Gerrit-Change-Number: 35387
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Comment-Date: Sat, 23 Dec 2023 09:14:57 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment
laforge has posted comments on this change. ( https://gerrit.osmocom.org/c/pysim/+/35418?usp=email )
Change subject: additional encode/decode test data for various files
......................................................................
Patch Set 4: Code-Review+2
--
To view, visit https://gerrit.osmocom.org/c/pysim/+/35418?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: pysim
Gerrit-Branch: master
Gerrit-Change-Id: Ib563a2204922d2013b5f7c5abde0773051e17938
Gerrit-Change-Number: 35418
Gerrit-PatchSet: 4
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Comment-Date: Sat, 23 Dec 2023 09:14:30 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment