diff options
Diffstat (limited to 'lib/mix/tasks')
| -rw-r--r-- | lib/mix/tasks/deactivate_user.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/generate_config.ex | 10 | ||||
| -rw-r--r-- | lib/mix/tasks/generate_invite_token.ex | 9 | ||||
| -rw-r--r-- | lib/mix/tasks/generate_password_reset.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/make_moderator.ex | 9 | ||||
| -rw-r--r-- | lib/mix/tasks/reactivate_user.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/register_user.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/relay_follow.ex | 7 | ||||
| -rw-r--r-- | lib/mix/tasks/relay_unfollow.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/rm_user.ex | 8 | ||||
| -rw-r--r-- | lib/mix/tasks/set_locked.ex | 11 | ||||
| -rw-r--r-- | lib/mix/tasks/unsubscribe_user.ex | 8 | 
12 files changed, 92 insertions, 10 deletions
diff --git a/lib/mix/tasks/deactivate_user.ex b/lib/mix/tasks/deactivate_user.ex index f18541787..e71ed1ec0 100644 --- a/lib/mix/tasks/deactivate_user.ex +++ b/lib/mix/tasks/deactivate_user.ex @@ -2,7 +2,13 @@ defmodule Mix.Tasks.DeactivateUser do    use Mix.Task    alias Pleroma.User -  @shortdoc "Deactivate a user" +  @moduledoc """ +  Deactivates a user (local or remote) + +  Usage: ``mix deactivate_user <nickname>`` + +  Example: ``mix deactivate_user lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/generate_config.ex b/lib/mix/tasks/generate_config.ex index 70a110561..e3cbbf131 100644 --- a/lib/mix/tasks/generate_config.ex +++ b/lib/mix/tasks/generate_config.ex @@ -1,7 +1,15 @@  defmodule Mix.Tasks.GenerateConfig do    use Mix.Task -  @shortdoc "Generates a new config" +  @moduledoc """ +  Generate a new config + +  ## Usage +  ``mix generate_config`` + +  This mix task is interactive, and will overwrite the config present at ``config/generated_config.exs``. +  """ +    def run(_) do      IO.puts("Answer a few questions to generate a new config\n")      IO.puts("--- THIS WILL OVERWRITE YOUR config/generated_config.exs! ---\n") diff --git a/lib/mix/tasks/generate_invite_token.ex b/lib/mix/tasks/generate_invite_token.ex index c4daa9a6c..418ef3790 100644 --- a/lib/mix/tasks/generate_invite_token.ex +++ b/lib/mix/tasks/generate_invite_token.ex @@ -1,7 +1,14 @@  defmodule Mix.Tasks.GenerateInviteToken do    use Mix.Task -  @shortdoc "Generate invite token for user" +  @moduledoc """ +  Generates invite token + +  This is in the form of a URL to be used by the Invited user to register themselves. + +  ## Usage +  ``mix generate_invite_token`` +  """    def run([]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/generate_password_reset.ex b/lib/mix/tasks/generate_password_reset.ex index 6bf640150..f7f4c4f59 100644 --- a/lib/mix/tasks/generate_password_reset.ex +++ b/lib/mix/tasks/generate_password_reset.ex @@ -2,7 +2,13 @@ defmodule Mix.Tasks.GeneratePasswordReset do    use Mix.Task    alias Pleroma.User -  @shortdoc "Generate password reset link for user" +  @moduledoc """ +  Generate password reset link for user + +  Usage: ``mix generate_password_reset <nickname>`` + +  Example: ``mix generate_password_reset lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/make_moderator.ex b/lib/mix/tasks/make_moderator.ex index a454a958e..15586dc30 100644 --- a/lib/mix/tasks/make_moderator.ex +++ b/lib/mix/tasks/make_moderator.ex @@ -1,9 +1,16 @@  defmodule Mix.Tasks.SetModerator do +  @moduledoc """ +  Set moderator to a local user + +  Usage: ``mix set_moderator <nickname>`` + +  Example: ``mix set_moderator lain`` +  """ +    use Mix.Task    import Mix.Ecto    alias Pleroma.{Repo, User} -  @shortdoc "Set moderator status"    def run([nickname | rest]) do      Application.ensure_all_started(:pleroma) diff --git a/lib/mix/tasks/reactivate_user.ex b/lib/mix/tasks/reactivate_user.ex index 40bd068ea..a30d3ac8b 100644 --- a/lib/mix/tasks/reactivate_user.ex +++ b/lib/mix/tasks/reactivate_user.ex @@ -2,7 +2,13 @@ defmodule Mix.Tasks.ReactivateUser do    use Mix.Task    alias Pleroma.User -  @shortdoc "Reactivate a user" +  @moduledoc """ +  Reactivate a user + +  Usage: ``mix reactivate_user <nickname>`` + +  Example: ``mix reactivate_user lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/register_user.ex b/lib/mix/tasks/register_user.ex index e74721c49..1f5321093 100644 --- a/lib/mix/tasks/register_user.ex +++ b/lib/mix/tasks/register_user.ex @@ -1,4 +1,12 @@  defmodule Mix.Tasks.RegisterUser do +  @moduledoc """ +  Manually register a local user + +  Usage: ``mix register_user <name> <nickname> <email> <bio> <password>`` + +  Example: ``mix register_user 仮面の告白 lain lain@example.org "blushy-crushy fediverse idol + pleroma dev" pleaseDontHeckLain`` +  """ +    use Mix.Task    alias Pleroma.{Repo, User} diff --git a/lib/mix/tasks/relay_follow.ex b/lib/mix/tasks/relay_follow.ex index ac6f20924..4d57c6bca 100644 --- a/lib/mix/tasks/relay_follow.ex +++ b/lib/mix/tasks/relay_follow.ex @@ -4,6 +4,13 @@ defmodule Mix.Tasks.RelayFollow do    alias Pleroma.Web.ActivityPub.Relay    @shortdoc "Follows a remote relay" +  @moduledoc """ +  Follows a remote relay + +  Usage: ``mix relay_follow <relay_url>`` + +  Example: ``mix relay_follow https://example.org/relay`` +  """    def run([target]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/relay_unfollow.ex b/lib/mix/tasks/relay_unfollow.ex index 4621ace83..bd69fd8a0 100644 --- a/lib/mix/tasks/relay_unfollow.ex +++ b/lib/mix/tasks/relay_unfollow.ex @@ -3,7 +3,13 @@ defmodule Mix.Tasks.RelayUnfollow do    require Logger    alias Pleroma.Web.ActivityPub.Relay -  @shortdoc "Follows a remote relay" +  @moduledoc """ +  Unfollows a remote relay + +  Usage: ``mix relay_follow <relay_url>`` + +  Example: ``mix relay_follow https://example.org/relay`` +  """    def run([target]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/rm_user.ex b/lib/mix/tasks/rm_user.ex index b7c922d6c..50463046c 100644 --- a/lib/mix/tasks/rm_user.ex +++ b/lib/mix/tasks/rm_user.ex @@ -2,7 +2,13 @@ defmodule Mix.Tasks.RmUser do    use Mix.Task    alias Pleroma.User -  @shortdoc "Permanently delete a user" +  @moduledoc """ +  Permanently deletes a user + +  Usage: ``mix rm_user [nickname]`` + +  Example: ``mix rm_user lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start") diff --git a/lib/mix/tasks/set_locked.ex b/lib/mix/tasks/set_locked.ex index 2b3b18b09..a154595ca 100644 --- a/lib/mix/tasks/set_locked.ex +++ b/lib/mix/tasks/set_locked.ex @@ -1,9 +1,18 @@  defmodule Mix.Tasks.SetLocked do +  @moduledoc """ +  Lock a local user + +  The local user will then have to manually accept/reject followers. This can also be done by the user into their settings. + +  Usage: ``mix set_locked <username>`` + +  Example: ``mix set_locked lain`` +  """ +    use Mix.Task    import Mix.Ecto    alias Pleroma.{Repo, User} -  @shortdoc "Set locked status"    def run([nickname | rest]) do      ensure_started(Repo, []) diff --git a/lib/mix/tasks/unsubscribe_user.ex b/lib/mix/tasks/unsubscribe_user.ex index bb72634b6..62ea61a5c 100644 --- a/lib/mix/tasks/unsubscribe_user.ex +++ b/lib/mix/tasks/unsubscribe_user.ex @@ -3,7 +3,13 @@ defmodule Mix.Tasks.UnsubscribeUser do    alias Pleroma.{User, Repo}    require Logger -  @shortdoc "Unsubscribe all users from a target and then deactivate them" +  @moduledoc """ +  Deactivate and Unsubscribe local users from a user + +  Usage: ``mix unsubscribe_user <nickname>`` + +  Example: ``mix unsubscribe_user lain`` +  """    def run([nickname]) do      Mix.Task.run("app.start")  | 
