Command-line interface¶
swh search¶
Software Heritage Search tools.
swh search [OPTIONS] COMMAND [ARGS]...
Options
-
-C
,
--config-file
<config_file>
¶ Configuration file.
journal-client¶
swh search journal-client [OPTIONS] COMMAND [ARGS]...
objects¶
Listens for new objects from the SWH Journal, and schedules tasks to run relevant indexers (currently, origin and origin_visit) on these new objects.
swh search journal-client objects [OPTIONS]
Options
-
-m
,
--stop-after-objects
<stop_after_objects>
¶ Maximum number of objects to replay. Default is to run forever.
-
-o
,
--object-type
<object_type>
¶ Default list of object types to subscribe to
-
-p
,
--prefix
<prefix>
¶ Topic prefix to use (e.g swh.journal.indexed)
rpc-serve¶
Starts a Software Heritage Indexer RPC HTTP server.
swh search rpc-serve [OPTIONS] CONFIG_PATH
Options
-
--host
<host>
¶ Host to run the server
-
--port
<port>
¶ Binding port of the server
-
--index-prefix
<index_prefix>
¶ The prefix to add before the index names
-
--debug
,
--nodebug
¶
Indicates if the server should run in debug mode
Arguments
-
CONFIG_PATH
¶
Required argument