glitch-soc flavored mastodon tootctl help text v2.9.2+glitch

help.txt

RAILS_ENV=production bin/tootctl version
2.9.2+glitch
                                                           
Commands:
  tootctl accounts SUBCOMMAND ...ARGS  # Manage accounts
  tootctl cache SUBCOMMAND ...ARGS     # Manage cache
  tootctl domains SUBCOMMAND ...ARGS   # Manage account domains
  tootctl emoji SUBCOMMAND ...ARGS     # Manage custom emoji
  tootctl feeds SUBCOMMAND ...ARGS     # Manage feeds
  tootctl help [COMMAND]               # Describe available commands or one specific command
  tootctl media SUBCOMMAND ...ARGS     # Manage media files
  tootctl search SUBCOMMAND ...ARGS    # Manage the search engine
  tootctl self-destruct                # Erase the server from the federation
  tootctl settings SUBCOMMAND ...ARGS  # Manage dynamic settings
  tootctl statuses SUBCOMMAND ...ARGS  # Manage statuses
  tootctl version                      # Show version

  tootctl accounts SUBCOMMAND ...ARGS  # Manage accounts
    tootctl accounts approve [USERNAME]             # Approve pending accounts
    tootctl accounts backup USERNAME                # Request a backup for a user
    tootctl accounts create USERNAME --email=EMAIL  # Create a new user
    tootctl accounts cull                           # Remove remote accounts that no longer exist
    tootctl accounts delete USERNAME                # Delete a user
    tootctl accounts follow ACCT                    # Make all local accounts follow account specified by ACCT
    tootctl accounts modify USERNAME                # Modify a user
    tootctl accounts refresh [USERNAME]             # Fetch remote user data and files
    tootctl accounts reset-relationships USERNAME   # Reset all follows and/or followers for a user
    tootctl accounts rotate [USERNAME]              # Generate and broadcast new keys
    tootctl accounts unfollow ACCT                  # Make all local accounts unfollow account specified by ACCT

  tootctl cache SUBCOMMAND ...ARGS     # Manage cache
    tootctl cache clear                # Clear out the cache storage
    
  tootctl domains SUBCOMMAND ...ARGS   # Manage account domains
    tootctl domains crawl [START]      # Crawl all known peers, optionally beginning at START
    tootctl domains purge DOMAIN       # Remove accounts from a DOMAIN without a trace

  tootctl emoji SUBCOMMAND ...ARGS     # Manage custom emoji                                                                      
    tootctl emoji import PATH          # Import emoji from a TAR GZIP archive at PATH
    tootctl emoji purge                # Remove all custom emoji
  
  tootctl feeds SUBCOMMAND ...ARGS     # Manage feeds
    tootctl feeds build [USERNAME]     # Build home and list feeds for one or all users
    tootctl feeds clear                # Remove all home and list feeds from Redis

  tootctl help [COMMAND]               # Describe available commands or one specific command                                      
  
  tootctl media SUBCOMMAND ...ARGS     # Manage media files
    tootctl media remove               # Remove remote media files
      Options:
        [--days=N]                     # Default: 7
        [--background], [--no-background]
        [--verbose], [--no-verbose]
        [--dry-run], [--no-dry-run]

      Description:
        Removes locally cached copies of media attachments from other servers.

        The --days option specifies how old media attachments have to be before they are removed. It defaults to 7 days.

        With the --background option, instead of deleting the files sequentially, they will be queued into Sidekiq and the command will exit as soon as
        possible. In Sidekiq they will be processed with higher concurrency, but it may impact other operations of the Mastodon server, and it may
        overload the underlying file storage.

        With the --dry-run option, no work will be done.

        With the --verbose option, when media attachments are processed sequentially in the foreground, the IDs of the media attachments will be printed.


  tootctl search SUBCOMMAND ...ARGS    # Manage the search engine
    tootctl search deploy              # Create or update an ElasticSearch index and populate it
  
  tootctl self-destruct                # Erase the server from the federation
    Options:
      [--dry-run], [--no-dry-run]

    Description:
      Erase the server from the federation by broadcasting account delete activities to all known other servers. This allows a "clean exit" from running a Mastodon server, as it leaves next to no cache behind on other servers.

      This command is always interactive and requires confirmation twice.

      No local data is actually deleted, because emptying the database or removing files is much faster through other, external means, such as e.g. deleting the entire VPS. However, because other servers will delete data about local users, but no local data will be updated (such as e.g. followers), there will be a state mismatch that will lead to glitches and issues if you then continue to run and use the server.

      So either you know exactly what you are doing, or you are starting from a blank slate afterwards by manually clearing out all the local data!
    
  tootctl settings SUBCOMMAND ...ARGS  # Manage dynamic settings
    tootctl settings registrations SUBCOMMAND ...ARGS  # Manage state of registrations
      tootctl registrations close           # Close registrations
      tootctl registrations help [COMMAND]  # Describe subcommands or one specific subcommand
      tootctl registrations open            # Open registrations
  
  tootctl statuses SUBCOMMAND ...ARGS  # Manage statuses
    tootctl statuses remove          # Remove unreferenced statuses
      Options:
        [--days=N]                   # Default: 90

      Description:
        Remove statuses that are not referenced by local user activity, such as ones that came from relays, or belonging to users that were once followed by someone locally but no longer are.

        This is a computationally heavy procedure that creates extra database indicides before commencing, and removes them afterward.