Command-line interface#
swh search#
Software Heritage Search tools.
swh search [OPTIONS] COMMAND [ARGS]...
Options
- -C, --config-file <config_file>#
Configuration file. This has a higher priority than SWH_CONFIG_FILENAME environment variable if set.
initialize#
Creates Elasticsearch indices.
swh search initialize [OPTIONS]
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#
Software Heritage Storage RPC server.
Do NOT use this in a production environment.
swh search rpc-serve [OPTIONS]
Options
- --host <IP>#
Host ip address to bind the server on
- Default:
'0.0.0.0'
- --port <PORT>#
Binding port of the server
- Default:
5010
- --debug, --no-debug#
Indicates if the server should run in debug mode