summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2026-05-13 13:30:38 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2026-05-13 13:55:50 +0200
commit8e5aa9d3945cc3cf8ab65dfc60ae4b69d5e53cf8 (patch)
tree3b341e84847787c29f6309ab082fd1b50a92da8f /docs/dev
parentcf4d7e31c4b80316897dd9e0ff30fa6fb1c1b8a2 (diff)
[doc] Development Quickstart: documentation of the tools (dev.env)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/quickstart.rst20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index 9fdee2e7b..3cf956c06 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -60,11 +60,29 @@ into the developer environment and start a python based HTTP server by::
$ ./manage dev.env
...
- (dev.env)$ SEARXNG_DEBUG=1 python -m searx.webapp
+ (dev.env)$ SEARXNG_DEBUG=1 searxng-run
Since this is a pure Python solution, you can set breakpoints in your code with
``pdb.set_trace()`` and the debugger will wait for you in the terminal prompt.
+Any other script or command line provided by SearXNG can also be used in the
+same environment, here are a few examples::
+
+ # tools related to favicons
+ (dev.env)$ python -m searx.favicons
+
+ # tools related to DATA stored in searx/data
+ (dev.env)$ python -m searx.data --help
+
+ # tools related to engines
+ (dev.env)$ python -m searx.enginelib --help
+
+ # to test one of the update scripts
+ (dev.env)$ searxng_extra/update/update_engine_traits.py --help
+
+ # to test the update of the wikidata units
+ (dev.env)$ searxng_extra/update/update_wikidata_units.py
+
.. sidebar:: further read