use kebab-case instead of snake_case for the cli

edsu · edsu · commit 6d0e52991869 · 2022-01-27T07:12:52.000-05:00
diff --git a/docs/twarc2_en_us.md b/docs/twarc2_en_us.md
@@ -229,17 +229,17 @@ conversation:
 
 ## Likes
 
-Twarc supports the two approaches that the Twitter API exposes for collecting likes via the `liked_tweets` and `liking_users` commands. 
+Twarc supports the two approaches that the Twitter API exposes for collecting likes via the `liked-tweets` and `liking-users` commands. 
 
-The `liked_tweets` command returns the tweets that have been liked by a specific account. The account is specified by the user ID of that account, in the following example is the account of Twitter's founder:
+The `liked-tweets` command returns the tweets that have been liked by a specific account. The account is specified by the user ID of that account, in the following example is the account of Twitter's founder:
 
-    twarc2 liked_tweets 12 jacks_likes.jsonl
+    twarc2 liked-tweets 12 jacks-likes.jsonl
 
 In this case the output file contains all of the likes of publicly accessible tweets. Note that the order of likes is not guaranteed by the API, but is probably reverse chronological, or most recent likes by that account first. The underlying tweet objects contain no information about when the tweet was liked.
 
-The `liking_users` command returns the user profiles of the accounts that have liked a specific tweet (specified by the ID of the tweet):
+The `liking-users` command returns the user profiles of the accounts that have liked a specific tweet (specified by the ID of the tweet):
 
-    twarc2 liking_users 1460417326130421765 liking_users.jsonl
+    twarc2 liking-users 1460417326130421765 liking-users.jsonl
 
 In this example the output file contains all of the user profiles of the publicly accessible accounts that have liked that specific tweet. Note that the order of profiles is not guaranteed by the API, but is probably reverse chronological, or the profile of the most recent like for that account first. The underlying profile objects contain no information about when the tweet was liked.
 
@@ -249,7 +249,7 @@ Note that likes of tweets that are not publicly accessible, or likes by accounts
 
 You can retrieve the user profiles of publicly accessible accounts that have retweeted a specific tweet, using the `retweeted_by` command and the ID of the tweet as an identifier. For example:
 
-    twarc2 retweeted_by 1460417326130421765 retweeting_users.jsonl
+    twarc2 retweeted-by 1460417326130421765 retweeting-users.jsonl
 
 Unfortunately this only returns the user profiles (presumably in reverse chronological order) of the retweeters of that tweet - this means that important information, like when the tweet was retweeted is not present in the returned object. 
 
diff --git a/twarc/command2.py b/twarc/command2.py
@@ -876,7 +876,7 @@ def following(T, user, outfile, limit, max_results, hide_progress):
                 break
 
 
-@twarc2.command("liking_users")
+@twarc2.command("liking-users")
 @click.option(
     "--limit",
     default=0,
@@ -927,7 +927,7 @@ def liking_users(T, tweet_id, outfile, limit, max_results, hide_progress):
                 break
 
 
-@twarc2.command("retweeted_by")
+@twarc2.command("retweeted-by")
 @click.option(
     "--limit",
     default=0,
@@ -978,7 +978,7 @@ def retweeted_by(T, tweet_id, outfile, limit, max_results, hide_progress):
                 break
 
 
-@twarc2.command("liked_tweets")
+@twarc2.command("liked-tweets")
 @click.option(
     "--limit",
     default=0,
