sbrl/systemquery
1
0
Fork 0
Code Issues Pull requests Releases Activity

Update subcommands

Browse source
This commit is contained in:
Starbeamrainbowlabs 2021-10-01 02:48:22 +01:00
parent ab1e52417d
commit 29799e4631
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
2 changed files with 4 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/subcommands/agent/meta.mjs
View file

@ -1,13 +1,6 @@
"use strict"; "use strict";
export default function(cli) { export default function(cli) {
cli.subcommand("download", "Downloads & anonymises Twitter data from the Academic API (not guaranteed to be downloaded in chronological order)") cli.subcommand("agent", "Starts the systemquery agent")
.argument("search", "The search string to query the Twitter API with", null, "string") .argument("config", "Specifies the config file location", "/etc/systemquery/systemquery.toml", "string");
.argument("start-time", "The start time to start downloading tweets from", null, "date")
.argument("end-time", "Optional. The end time to finish downloading tweets at", null, "date")
.argument("credentials", "Path to a (TOML formatted) credentials file to use. See the README for more information on the format.")
.argument("output", "Path to the directory to write the output to", null, "string")
.argument("max-query-length", "The maximum query length. Default: 1024. This only needs changing if you're not on the academic product track (which is the only track supported by this tool at the current time)", 1024, "integer")
.argument("tweets-per-request", "Max number of tweets to ask for per api call. Default: 100, can range from 10 to 500. Keep at a low value during testing, then bump it to max for the actual run.", 100, "integer")
.argument("no-replies", "Do not download replies to tweets. Speeds up execution, but of course yields less data.", false, "boolean");
} }

6
src/subcommands/query/meta.mjs
View file

@ -1,8 +1,6 @@
"use strict"; "use strict";
export default function(cli) { export default function(cli) {
cli.subcommand("anonymise", "Anonymises tweets in a jsonl file. Output file is <filename_without_ext>-anonymised.<ext>. Note that this is done automatically on download - you do NOT need to run this manually unless you have data from elsewhere.") cli.subcommand("query", "Query the cluster [requires agent with the query permission to be running on this host]")
.argument("input", "Path to the input file to anonymise.", null, "string") .argument("address", "Address of the agent to connect to.", "unix-abstract:systemquery", "string");
.argument("type", "The type of object to anonymise. Default: tweet. Possible values: tweet, user.", "tweet", "string")
.argument("credentials", "Path to a (TOML formatted) credentials file that contains the salt to use for anonymisation. See the README for more information on the format.")
} }