Admin Console Reference

These are the commands you can use in the Admin Console.

The first word is a command. Every word after that is an argument to that command. Every command has a different number of required and optional parameters. White space delimits arguments. If you need a space in an argument, put double quotes around the whole thing. If you need double quotes and spaces in an argument, escape the quote with a backslash (\) first. If you need to do a backslash, escape that with a backslash.

Arguments in <angle brackets> are required. Arguments in [brackets] are optional. If there is more than one optional argument, you can't skip one and provide one after it. Once you skip one, you have to skip the rest.

ban_list
ban_set
ban_unset
bonus_icons
community
faqcat
help
manage_circle
moodtheme_create
moodtheme_list
moodtheme_setpic
print
set
tag_display
tag_permissions

`allow_open_proxy` `<ip> [ <forever> ]`

You are not permitted to run this command.

Marks an IP address as not being an open proxy for the next 24 hours.

ip: The IP address to mark as clear.
forever: Optional; set to 'forever' if this proxy should be allowed forever.

`ban_list` `[ "from" <user> ]`

Lists users who are banned from an account.

user: Optional; lists bans in a community you maintain, or any user if you have the 'finduser' priv.

`ban_set` `<user> [ "from" <community> ]`

Ban another user from posting in your journal or community.

user: The user you want to ban.
community: Optional; to ban a user from a community you maintain.

`ban_unset` `<user> [ "from" <community> ]`

Remove a ban on a user.

user: The user you want to unban.
community: Optional; to unban a user from a community you maintain.

`bonus_icons` `<username> [<subcommand> <count>]`

Manage bonus icons for an account.

command: Subcommand: add, remove.
username: Username to act on.
count: How many icons to add or remove.

`change_community_admin` `<community> <new_owner>`

You are not permitted to run this command.

Transfer maintainership of a community to another user.

community: The username of the community.
new_owner: The username of the new owner of the community.

`change_journal_status` `<account> <status>`

You are not permitted to run this command.

Change the status of an account.

account: The account to update.
status: One of 'normal', 'memorial' (no new entries), 'locked' (no new entries or comments), or 'readonly' (no new entries or comments, but can log in and delete entries and comments), 'deleted'.

`change_journal_type` `<journal> <type> <owner> [force]`

You are not permitted to run this command.

Change a journal's type.

journal: The username of the journal that type is changing.
type: Either 'person' or 'community'.
owner: The person to become the maintainer of the community journal. If changing to type 'person', the account will adopt the email address and password of the owner.
force: Specify this to create a community from a non-empty journal. The maintainer of the community will be the owner of the journal's entries.

`comment` `<action> <url> <reason>`

You are not permitted to run this command.

Manage comments in an account.

action: One of: screen, unscreen, freeze, unfreeze, delete, delete_thread.
url: The URL to the comment. (Use the permanent link that shows this comment topmost.)
reason: Reason this action is being taken.

`community` `<community> <action> <user>`

Add or remove a user from a community.

community: The username of the community.
action: Only 'remove' is supported right now.
user: The user you want to remove from the community.

`email_alias` `<action> <alias> [ <value> ]`

You are not permitted to run this command.

View and edit email aliases.

action: One of: 'show' (to view recipient), 'delete' (to delete), or 'set' (to set a value)
alias: The first portion of the email alias (eg, just the username)
value: Value to set the email alias to, if using 'set'.

`entry` `<action> <url> <reason>`

You are not permitted to run this command.

Manage entries in an account

action: Currently only 'delete'
url: The URL to the entry
reason: Reason this action is being taken

`expunge_userpic` `<url>`

You are not permitted to run this command.

Expunge a userpic from the site.

url: URL of the userpic to expunge

`faqcat` `<command> <commandargs>`

Tool for managing FAQ categories.

command: One of: list, delete, add, move. 'list' shows all the defined FAQ categories, including their catkey, name, and sortorder. Also, it shows all the distinct catkeys that are in use by FAQ. 'add' creates or modifies a FAQ category. 'delete' removes a FAQ category (but not the questions that are in it). 'move' moves a FAQ category up or down in the list.
commandargs: 'add' takes 3 arguments: a catkey, a catname, and a sort order field. 'delete' takes one argument: the catkey value. 'move' takes two arguments: the catkey and either the word 'up' or 'down'.

`find_user_cluster` `<user>`

You are not permitted to run this command.

List the name of the cluster a user is on.

user: Username of the account to look up

`finduser` `<criteria> <data>`

You are not permitted to run this command.

Finds all accounts matching a certain criterion.

criteria: One of: 'user', 'userid', 'email', or 'timeupdate'.
data: Either a username or email address, or a userid when using 'userid'.

`get_maintainer` `<user>`

You are not permitted to run this command.

Given a community username, lists all maintainers. Given a user account, lists all communities that the user maintains.

user: The username of the account you want to look up.

`get_moderator` `<user>`

You are not permitted to run this command.

Given a community username, lists all moderators. Given a user account, lists all communities that the user moderates.

user: The username of the account you want to look up.

`get_relation` `<user> <edge>`

You are not permitted to run this command.

Given a username and an edge, looks up all relations.

user: The username of the account you want to look up.
edge: The reluser edge to look up.

`help` `[ <command> ]`

Get help on console commands.

command: A command to get help on. If omitted, prints help for all commands.

`infohistory` `<user>`

You are not permitted to run this command.

Retrieve info history of a given account.

user: The username of the account whose infohistory to retrieve.

`invalid command`

This specifies the console's behavior for invalid input.

`make_invites` `<username> <count> <reason>`

You are not permitted to run this command.

Make invite codes.

owner: The username of the account on whose behalf the invite codes are generated
count: Number of invite codes to generate
reason: Why you're generating those invite codes

`manage_circle` `<subcommand> <username> [groups]`

Manage your circle of relationships.

command: Subcommand: add_read, del_read, add_access, del_access.
username: Username to act on.
groups: If using add_access, a comma separated list of trust group ids. Will add to the list of groups this user is already in.

`moodtheme_create` `<name> <desc>`

Create a new moodtheme. Returns the mood theme ID that you'll need to define moods for this theme.

name: Name of this theme.
desc: A description of the theme

`moodtheme_list` `[ <themeid> ]`

List mood themes, or data about a mood theme.

themeid: Optional; mood theme ID to view data for. If not given, lists all available mood themes.

`moodtheme_public` `<themeid> <setting>`

You are not permitted to run this command.

Mark a mood theme as public or not.

themeid: Mood theme ID number.
setting: Either 'Y' or 'N' to make it public or not public, respectively.

`moodtheme_setpic` `<themeid> <moodid> <picurl> <width> <height>`

Change data for a mood theme. If picurl, width, or height is empty or zero, the data is deleted.

themeid: Mood theme ID number.
moodid: Mood ID number.
picurl: URL of picture for this mood. Use /img/mood/themename/file.gif for public mood images
width: Width of picture
height: Height of picture

`print` `...`

This is a debugging function. Given any number of arguments, it'll print each one back to you. If an argument begins with a bang (!), then it'll be printed to the error stream instead.

`priv` `<action> [ <privs> [ <usernames> ] ]`

You are not permitted to run this command.

Grant or revoke user privileges, or list available privileges and their arguments.

action: 'list', 'grant', 'revoke', or 'revoke_all' to revoke all args for a given priv.
privs: Comma-delimited list of priv names, priv:arg pairs, or package names (prefixed with #). Required for all actions except 'list'. Using 'list' with no arguments will return results for all privs.
usernames: Comma-delimited list of usernames (not used for 'list').

`priv_package` `<command> [ <package> [ <arg> ] ]`

You are not permitted to run this command.

Manage packages of admin privs. Basic workflow: priv_package create mypkg "Test Package", priv_package add mypkg admin:*, priv_package list. To actually grant a package to someone, priv grant #mypkg username. Works for revoke as well.

command: One of "list", "create", "add", "remove", "delete".
package: The package to operate on. Use a short name.
arg: If command is "list", no argument to see all packages, or provide a package to see the privs inside. For "create" and "delete" of a package, no argument. For "add" and "remove", arg is the privilege being granted in "privname:privarg" format.

`rename_opts` `redirect from_nonexistent_user to_existing_user | break_email_redirect from_user to_user | <subcommand> <username>`

You are not permitted to run this command.

Manage options attached to a rename.

command: Subcommand: redirect, break_redirect, break_redirect_email, del_trusted_by, del_watched_by, del_trusted, del_watched, del_communities.
username: Username to act on.

`reset_email` `<user> <value> <reason>`

You are not permitted to run this command.

Resets the email address of a given account.

user: The account to reset the email address for.
value: Email address to set the account to.
reason: Reason for the reset

`reset_password` `<user> <reason>`

You are not permitted to run this command.

Resets the password for a given account

user: The account to reset the email address for.
reason: Reason for the password reset.

`set` `[ "for" <community> ] <propname> <value>`

Set the value of a userprop.

community: Optional; community to set property for, if you're a maintainer.
propname: Property name to set.
value: Value to set property to.

`set_badpassword` `<user> <state> <reason>`

You are not permitted to run this command.

Mark or unmark an account as having a bad password.

user: The username of the journal to mark/unmark
state: Either 'on' (to mark as having a bad password) or 'off' (to unmark)
reason: Reason why you are setting this status.

`suspend` `<username or email address or entry url> <reason>`

You are not permitted to run this command.

Suspend an account or entry.

username or email address or entry url: The username of the account to suspend, or an email address to suspend all accounts at that address, or an entry URL to suspend a single entry within an account
reason: Why you're suspending the account or entry.

`syn_editurl` `<user> <newurl>`

You are not permitted to run this command.

Changes the source feed URL for a syndicated account.

user: The username of the syndicated account.
newurl: The new source feed URL.

`syn_merge` `<from_user> "to" <to_user> "using" <url>`

You are not permitted to run this command.

Merge two syndicated accounts into one, setting up a redirect and using one account's URL.

from_user: Syndicated account to merge into another.
to_user: Syndicated account to merge 'from_user' into.
url: Source feed URL to use for 'to_user'. Specify the direct URL to the feed.

`sysban_add` `<what> <value> [ <days> ] [ <note> ]`

You are not permitted to run this command.

Block an action based on certain criteria

what: The criterion you're blocking
value: The value you're blocking
days: Length of the ban, in days (or 0 for forever)
note: Reason why you're setting this ban

`tag_display` `[ "for" <community> ] <tag> <value>`

Set tag visibility to S2.

community: Community that this tag is in, if applicable.
tag: The tag to change the display value of. This must be quoted if it contains any spaces.
value: Either 'on' to display tag, or 'off' to hide it.

`tag_permissions` `[ "for" <community> ] <add level> <control level>`

Set tagging permission levels for an account.

community: Optional; community to change permission levels for.
add level: Accounts at this level can add existing tags to entries. Value is one of 'public', 'access' (for personal journals), 'members' (for communities), 'author_admin' (for communities only), 'private', 'none', or a custom group name.
control level: Accounts at this level can do everything: add, remove, and create new tags. Value is one of 'public', 'access' (for personal journals), 'members' (for communities), 'private', 'none', or a custom group name.

`unsuspend` `<username or email address or entry url> <reason>`

You are not permitted to run this command.

Unsuspend an account or entry.

username or email address or entry url: The username of the account to unsuspend, or an email address to unsuspend all accounts at that address, or an entry URL to unsuspend a single entry within an account
reason: Why you're unsuspending the account or entry

Account name:	Log in with OpenID?
Password:	Forget your password?
	Remember me

Admin Console Reference

allow_open_proxy <ip> [ <forever> ]

ban_list [ "from" <user> ]

ban_set <user> [ "from" <community> ]

ban_unset <user> [ "from" <community> ]

bonus_icons <username> [<subcommand> <count>]

change_community_admin <community> <new_owner>

change_journal_status <account> <status>

change_journal_type <journal> <type> <owner> [force]

comment <action> <url> <reason>

community <community> <action> <user>

email_alias <action> <alias> [ <value> ]

entry <action> <url> <reason>

expunge_userpic <url>

faqcat <command> <commandargs>

find_user_cluster <user>

finduser <criteria> <data>

get_maintainer <user>

get_moderator <user>

get_relation <user> <edge>

help [ <command> ]

infohistory <user>

invalid command

make_invites <username> <count> <reason>

manage_circle <subcommand> <username> [groups]

moodtheme_create <name> <desc>

moodtheme_list [ <themeid> ]

moodtheme_public <themeid> <setting>

moodtheme_setpic <themeid> <moodid> <picurl> <width> <height>

print ...

priv <action> [ <privs> [ <usernames> ] ]

priv_package <command> [ <package> [ <arg> ] ]

rename_opts redirect from_nonexistent_user to_existing_user | break_email_redirect from_user to_user | <subcommand> <username>

reset_email <user> <value> <reason>

reset_password <user> <reason>

set [ "for" <community> ] <propname> <value>

set_badpassword <user> <state> <reason>

suspend <username or email address or entry url> <reason>

syn_editurl <user> <newurl>

syn_merge <from_user> "to" <to_user> "using" <url>

sysban_add <what> <value> [ <days> ] [ <note> ]

tag_display [ "for" <community> ] <tag> <value>

tag_permissions [ "for" <community> ] <add level> <control level>

unsuspend <username or email address or entry url> <reason>

`allow_open_proxy` `<ip> [ <forever> ]`

`ban_list` `[ "from" <user> ]`

`ban_set` `<user> [ "from" <community> ]`

`ban_unset` `<user> [ "from" <community> ]`

`bonus_icons` `<username> [<subcommand> <count>]`

`change_community_admin` `<community> <new_owner>`

`change_journal_status` `<account> <status>`

`change_journal_type` `<journal> <type> <owner> [force]`

`comment` `<action> <url> <reason>`

`community` `<community> <action> <user>`

`email_alias` `<action> <alias> [ <value> ]`

`entry` `<action> <url> <reason>`

`expunge_userpic` `<url>`

`faqcat` `<command> <commandargs>`

`find_user_cluster` `<user>`

`finduser` `<criteria> <data>`

`get_maintainer` `<user>`

`get_moderator` `<user>`

`get_relation` `<user> <edge>`

`help` `[ <command> ]`

`infohistory` `<user>`

`invalid command`

`make_invites` `<username> <count> <reason>`

`manage_circle` `<subcommand> <username> [groups]`

`moodtheme_create` `<name> <desc>`

`moodtheme_list` `[ <themeid> ]`

`moodtheme_public` `<themeid> <setting>`

`moodtheme_setpic` `<themeid> <moodid> <picurl> <width> <height>`

`print` `...`

`priv` `<action> [ <privs> [ <usernames> ] ]`

`priv_package` `<command> [ <package> [ <arg> ] ]`

`rename_opts` `redirect from_nonexistent_user to_existing_user | break_email_redirect from_user to_user | <subcommand> <username>`

`reset_email` `<user> <value> <reason>`

`reset_password` `<user> <reason>`

`set` `[ "for" <community> ] <propname> <value>`

`set_badpassword` `<user> <state> <reason>`

`suspend` `<username or email address or entry url> <reason>`

`syn_editurl` `<user> <newurl>`

`syn_merge` `<from_user> "to" <to_user> "using" <url>`

`sysban_add` `<what> <value> [ <days> ] [ <note> ]`

`tag_display` `[ "for" <community> ] <tag> <value>`

`tag_permissions` `[ "for" <community> ] <add level> <control level>`

`unsuspend` `<username or email address or entry url> <reason>`