aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started_command_line.rst
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2020-10-01 23:04:58 +0200
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2020-10-01 23:04:58 +0200
commit8453c268f55ef7cfbc2fe6a6bc5c8ca7a67c8880 (patch)
tree2d4e0a4da734ee86cc546a92c383578ff59c8a3e /docs/getting_started_command_line.rst
parentd120ee47de7d3c02a8420e3a615c6269f88def9c (diff)
Moved misc docs to sphinx
Diffstat (limited to 'docs/getting_started_command_line.rst')
-rw-r--r--docs/getting_started_command_line.rst61
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/getting_started_command_line.rst b/docs/getting_started_command_line.rst
deleted file mode 100644
index d2e4378..0000000
--- a/docs/getting_started_command_line.rst
+++ /dev/null
@@ -1,61 +0,0 @@
-Getting Started (Command Line)
-==============================
-
-lesana can be used from the command line through the ``lesana`` command;
-for more details run ``lesana help``.
-
-Many commands will try to open some file in an editor: they will attempt
-to use, in this order, ``$EDITOR``, ``sensible-editor`` or as a fallback
-``vi``, which should be installed on any POSIX-like system.
-
-To start a new collection, create a directory and run ``lesana
-init`` into it::
-
- mkdir $DIRECTORY
- cd $DIRECTORY
- lesana init
-
-It will create the basic file structure of a lesana collection,
-including a ``settings.yaml`` skeleton and it will initialize a git
-repository (use ``--no-git`` to skip this part and ignore all further
-git commands).
-
-It will then open ``settings.yaml`` in an editor: fill in your list of
-fields and all other data, save and exit.
-You are now ready to commit the configuration for your new collection::
-
- git commit -m 'Collection settings'
-
-An empty collection is not very interesting: let us start adding new
-entries::
-
- lesana new
-
-It will again open an editor on a skeleton of entry where you can fill
-in the values. When you close the editor it will print the entry id,
-that you can use e.g. to edit again the same entry::
-
- lesana edit $ENTRY_ID
-
-After you've added a few entries, you can now search for some word that
-you entered in one of the indexed fields::
-
- lesana search some words
-
-this will also print the entry ids of matching items, so that you can
-open them with ``lesana edit``.
-
-If you're using git, entries will be autoadded to the staging area, but
-you need to commit them, so that you can choose how often you do so.
-
-Search results are limited by default to 12 matches; to get all results
-for your query you can use the option ``--all``. This is especially
-useful when passing the results to a template::
-
- lesana search --template templates/my_report.html --all \
- some search terms \
- > some_search_terms-report.html
-
-will generate an html file based on the jinja2 template
-``templates/my_report.html`` with all the entries found for those search
-terms.