This is an old revision of the document!
Admidio command-line utility
Note: This documentation is automatically generated by `help –all –format=dokuwiki –output=admidio-cli-commands.txt`
admidio [global-options] COMMAND [arguments] [options]
| Option | Description |
| –config=FILE | Configuration file to use instead of adm_my_files/config.php. |
| –host=HOST | Host used by host-dependent config.php files. |
| –organization=ORG | Organization short name. |
| –as=USER | Acting Admidio user for rights and audit identity. |
| –format=FORMAT | Output format where supported. Possible values: text, table, record, json, csv, md, dokuwiki. |
| –output=FILE | Write command output to a file. |
| –quiet | Suppress confirmation messages. Requested data and errors are still printed. Short form -q. |
| –no-interaction | Never ask an interactive question. |
| –yes | Confirm destructive operations. Short form -y. |
| –help | Show help for the selected command. Short form -h. |
admidio announcement:add --headline=TEXT --category=CATEGORY (--description=TEXT|--description-file=FILE)
| Option | Description |
| –headline=TEXT | Headline. |
| –category=CATEGORY | Announcement category. |
| –description=TEXT | HTML/text description. |
| –description-file=FILE | Read description from file. |
admidio announcement:copy ANNOUNCEMENT [--headline=TEXT] [--category=CATEGORY]
| Argument | Required | Description |
| announcement | yes | Source announcement. |
| Option | Description |
| –headline=TEXT | Headline. |
| –category=CATEGORY | Announcement category. |
| –description=TEXT | HTML/text description. |
| –description-file=FILE | Read description from file. |
admidio announcement:delete ANNOUNCEMENT [--yes]
| Argument | Required | Description |
| announcement | yes | Announcement. |
| Option | Description |
| –yes | Confirm deletion. |
Generate the announcements RSS feed.
admidio announcement:export-rss [--category=CATEGORY] [--output=FILE]
| Option | Description |
| –category=CATEGORY | Announcement category. |
List announcements visible to the acting user.
admidio announcement:list [--category=CATEGORY] [--search=TEXT] [--limit=N] [--offset=N] [--format=FORMAT]
| Option | Description |
| –category=CATEGORY | Announcement category. |
| –search=TEXT | Headline/description search. |
| –limit=N | Maximum records. |
| –offset=N | Result offset. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
admidio announcement:show ANNOUNCEMENT [--format=text|json]
| Argument | Required | Description |
| announcement | yes | Announcement UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio announcement:update ANNOUNCEMENT [options]
| Argument | Required | Description |
| announcement | yes | Announcement. |
| Option | Description |
| –headline=TEXT | Headline. |
| –category=CATEGORY | Announcement category. |
| –description=TEXT | HTML/text description. |
| –description-file=FILE | Read description from file. |
Run native auto-login table cleanup.
admidio autologin:cleanup
Create a category-report configuration.
admidio category-report:add --name=NAME --column=COLUMN ... [options]
The acting user selected with –as must be an Admidio administrator.
| Option | Description |
| –name=NAME | Configuration name. |
| –role=GROUP … | Restrict report to role/group. |
| –category=CATEGORY … | Restrict report to role category. |
| –column=COLUMN … | Report column code. |
| –condition=CONDITION … | Condition aligned with –column; repeat in column order. |
| –number-column=BOOL | Show running row number. |
| –default=BOOL | Make this the default report configuration. |
Copy a category-report configuration.
admidio category-report:copy CONFIG [--name=NAME]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| config | yes | Report config id/name. |
| Option | Description |
| –name=NAME | Name of the copied configuration. |
Delete a category-report configuration.
admidio category-report:delete CONFIG [--yes]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| config | yes | Report config id/name. |
| Option | Description |
| –yes | Confirm deletion. |
List category-report configurations.
admidio category-report:list [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Run a category-report configuration.
admidio category-report:run CONFIG [--date=DATE] [--filter=TEXT] [--format=FORMAT]
| Argument | Required | Description |
| config | yes | Report config id/name. |
| Option | Description |
| –date=DATE | Reference date. |
| –filter=TEXT | Only include rows containing text. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Show a category-report configuration.
admidio category-report:show CONFIG [--format=text|json]
| Argument | Required | Description |
| config | yes | Report config UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update a category-report configuration.
admidio category-report:update CONFIG [options]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| config | yes | Report config id/name. |
| Option | Description |
| –name=NAME | Configuration name. |
| –role=GROUP … | Restrict report to role/group. |
| –category=CATEGORY … | Restrict report to role category. |
| –column=COLUMN … | Report column code (for example p12, r4, l4, udummy). |
| –condition=CONDITION … | Condition aligned with –column; repeat in column order. |
| –number-column=BOOL | Show running row number. |
| –default=BOOL | Make this the default report configuration. |
Create a category with native view/edit RolesRights.
admidio category:add TYPE NAME [options]
| Argument | Required | Description |
| type | yes | Category type. |
| name | yes | Category name. |
| Option | Description |
| –view-role=GROUP … | Role allowed to view this category. |
| –edit-role=GROUP … | Role allowed to edit this category. |
| –multi-organization=BOOL | Use a global category (cat_org_id NULL). |
| –default=BOOL | Make this the default category of its type. |
Delete an empty non-system category.
admidio category:delete CATEGORY [--yes]
| Argument | Required | Description |
| category | yes | Category. |
| Option | Description |
| –yes | Confirm deletion. |
admidio category:list [--type=ANN|AWA|EVT|FOT|IVT|LNK|ROL|USF] [--format=FORMAT]
| Option | Description |
| –type=TYPE | Category type. Possible values: ANN, AWA, EVT, FOT, IVT, LNK, ROL, USF. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Move a category one position.
admidio category:move CATEGORY up|down
| Argument | Required | Description |
| category | yes | Category. |
| direction | yes | up or down. |
admidio category:show CATEGORY [--format=text|json]
| Argument | Required | Description |
| category | yes | Category UUID/id/name. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update a category and its view/edit rights.
admidio category:update CATEGORY [--name=NAME] [options]
| Argument | Required | Description |
| category | yes | Category. |
| Option | Description |
| –name=NAME | Category name. |
| –view-role=GROUP … | Role allowed to view this category. |
| –edit-role=GROUP … | Role allowed to edit this category. |
| –multi-organization=BOOL | Use a global category (cat_org_id NULL). |
| –default=BOOL | Make this the default category of its type. |
List permitted changelog records.
admidio changelog:list [--table=TABLE ...] [--object=UUID] [--user=USER] [--date-from=DATE] [--date-to=DATE] [--action=ACTION] [--format=FORMAT]
| Option | Description |
| –table=TABLE … | Database table. |
| –object=UUID | Object UUID. |
| –user=USER | Creating user. |
| –date-from=DATE | Start date. |
| –date-to=DATE | End date. |
| –action=ACTION | create, change or delete. Possible values: create, change, delete. |
| –limit=N | Maximum records. |
| –offset=N | Result offset. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Show one permitted changelog record.
admidio changelog:show CHANGE [--format=text|json]
| Argument | Required | Description |
| change | yes | Log change id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Validate the command line itself: registration, help and the internal consistency of its source. Needs no acting user. Exits with 3 when a problem is found.
admidio cli:selfcheck [--format=table|json|csv|md|dokuwiki]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
admidio cli:selfcheck --format=json
Print a shell completion script for the Admidio command line.
admidio completion [bash|zsh]
| Argument | Required | Description |
| shell | no | Shell to generate the script for. Defaults to bash. |
admidio completion bash > /etc/bash_completion.d/admidio
admidio completion zsh > "${fpath[1]}/_admidio"
Delete an organization preference.
admidio config:delete NAME [--yes]
| Argument | Required | Description |
| name | yes | Preference name. |
| Option | Description |
| –yes | Confirm deletion. |
admidio config:get NAME [--type=raw|string|int|float|bool] [--format=text|json]
| Argument | Required | Description |
| name | yes | Preference name. |
| Option | Description |
| –type=TYPE | Typed SettingsManager getter. Possible values: raw, string, int, float, bool. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
List organization preferences.
admidio config:list [--filter=PATTERN] [--format=table|json|csv|md|dokuwiki]
| Option | Description |
| –filter=PATTERN | Only include preference names containing this text. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Store a preference through SettingsManager.
admidio config:set NAME VALUE
| Argument | Required | Description |
| name | yes | Preference name. |
| value | yes | Preference value. |
Create a native Admidio database dump.
admidio database:backup [--output=FILE]
Download a managed document.
admidio document:download FILE [--output=FILEPATH]
| Argument | Required | Description |
| file | yes | File UUID. |
admidio document:file-delete FILE [--yes]
| Argument | Required | Description |
| file | yes | File UUID. |
| Option | Description |
| –yes | Confirm deletion. |
admidio document:file-move FILE DESTINATION_FOLDER
| Argument | Required | Description |
| file | yes | File UUID. |
| destination-folder | yes | Destination folder UUID. |
admidio document:file-rename FILE NAME
| Argument | Required | Description |
| file | yes | File UUID. |
| name | yes | New filename. |
admidio document:folder-add PARENT_FOLDER NAME
| Argument | Required | Description |
| parent-folder | yes | Parent folder UUID; use root UUID for root. |
| name | yes | Folder name. |
Delete a managed folder recursively where native rights permit.
admidio document:folder-delete FOLDER [--yes]
| Argument | Required | Description |
| folder | yes | Folder UUID. |
| Option | Description |
| –yes | Confirm recursive deletion. |
admidio document:folder-move FOLDER DESTINATION_FOLDER
| Argument | Required | Description |
| folder | yes | Folder UUID. |
| destination-folder | yes | Destination folder UUID. |
admidio document:folder-rename FOLDER NAME
| Argument | Required | Description |
| folder | yes | Folder UUID. |
| name | yes | New folder name. |
List folders/files visible below a folder.
admidio document:list [FOLDER] [--recursive] [--format=FORMAT]
| Argument | Required | Description |
| folder | no | Folder UUID; empty means root. |
| Option | Description |
| –recursive | Traverse recursively. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Show folder view/upload role assignments.
admidio document:permissions FOLDER [--format=text|json]
| Argument | Required | Description |
| folder | yes | Folder UUID. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Set folder view/upload role assignments.
admidio document:permissions-set FOLDER [--view-role=GROUP ...] [--upload-role=GROUP ...] [--public=BOOL] [--recursive=BOOL]
| Argument | Required | Description |
| folder | yes | Folder UUID. |
| Option | Description |
| –view-role=GROUP … | View role. |
| –upload-role=GROUP … | Upload role. |
| –public=BOOL | Folder public flag. |
| –recursive=BOOL | Apply rights recursively. |
Register physical child entries missing from the database.
admidio document:register FOLDER [--recursive]
| Argument | Required | Description |
| folder | yes | Folder UUID. |
| Option | Description |
| –recursive | Register recursively. |
Find physical folders/files not registered in the database.
admidio document:unregistered [FOLDER] [--format=FORMAT]
| Argument | Required | Description |
| folder | no | Folder UUID; root if omitted. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Upload a managed document.
admidio document:upload FILEPATH --folder=FOLDER [--name=NAME]
| Argument | Required | Description |
| filepath | yes | Local file path. |
| Option | Description |
| –folder=FOLDER | Destination folder. |
| –name=NAME | Stored filename. |
Send the configured Admidio test email to the acting administrator.
Generate the forum RSS feed.
admidio forum:export-rss [--category=CATEGORY] [--output=FILE]
| Option | Description |
| –category=CATEGORY | Forum category. |
admidio forum:list [--category=CATEGORY] [--format=FORMAT]
| Option | Description |
| –category=CATEGORY | Forum category. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
admidio forum:post-add TOPIC (--text=TEXT|--text-file=FILE)
| Argument | Required | Description |
| topic | yes | Topic. |
| Option | Description |
| –text=TEXT | Post text. |
| –text-file=FILE | Read post from file. |
admidio forum:post-delete POST [--yes]
| Argument | Required | Description |
| post | yes | Post. |
| Option | Description |
| –yes | Confirm deletion. |
admidio forum:post-update POST (--text=TEXT|--text-file=FILE)
| Argument | Required | Description |
| post | yes | Post UUID/id. |
| Option | Description |
| –text=TEXT | Post text. |
| –text-file=FILE | Read post from file. |
Show a forum topic and its posts.
admidio forum:topic TOPIC [--format=text|json]
| Argument | Required | Description |
| topic | yes | Topic UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Create a forum topic with its first post.
admidio forum:topic-add --category=CATEGORY --title=TEXT (--text=TEXT|--text-file=FILE)
| Option | Description |
| –category=CATEGORY | Forum category. |
| –title=TEXT | Topic title. |
| –text=TEXT | First post text. |
| –text-file=FILE | Read first post from file. |
Delete a forum topic and its posts.
admidio forum:topic-delete TOPIC [--yes]
| Argument | Required | Description |
| topic | yes | Topic. |
| Option | Description |
| –yes | Confirm deletion. |
admidio forum:topic-update TOPIC [--category=CATEGORY] [--title=TEXT]
| Argument | Required | Description |
| topic | yes | Topic. |
| Option | Description |
| –category=CATEGORY | Forum category. |
| –title=TEXT | Topic title. |
admidio group:activate GROUP
| Argument | Required | Description |
| group | yes | Group. |
admidio group:add NAME --category=CATEGORY [options]
| Argument | Required | Description |
| name | yes | Role name. |
| Option | Description |
| –category=CATEGORY | Role category. |
| –name=NAME | Role name. |
| –description=TEXT | Role description. |
| –mail-to-role=MODE | Who may mail this role (0-3). |
| –view-memberships=MODE | Who may view memberships (0-3). |
| –view-profiles=MODE | Who may view member profiles (0-3). |
| –leader-rights=MODE | Leader rights (0-3). |
| –default-list=LIST | Default list configuration. |
| –default-registration=BOOL | Assign role by default to registrations. |
| –max-members=N | Maximum member count. |
| –cost=NUMBER | Role cost. |
| –cost-period=PERIOD | Cost period. |
| –start=DATE | Role start date YYYY-MM-DD. |
| –end=DATE | Role end date YYYY-MM-DD. |
| –start-time=TIME | Role start time HH:MM. |
| –end-time=TIME | Role end time HH:MM. |
| –weekday=DAY | Weekday number. |
| –location=TEXT | Meeting location. |
Add a dependent child role.
admidio group:adddependency GROUP DEPENDENT_GROUP
| Argument | Required | Description |
| group | yes | Parent group. |
| dependent-group | yes | Dependent child group. |
Assign a user to a group.
admidio group:adduser GROUP USER [--start=DATE] [--end=DATE] [--leader=BOOL] [--force-period]
| Argument | Required | Description |
| group | yes | Group. |
| user | yes | User. |
| Option | Description |
| –start=DATE | Membership start date. |
| –end=DATE | Membership end date. |
| –leader=BOOL | Leader status. |
| –force-period | Pass forcePeriod=true to Role::setMembership(). |
admidio group:deactivate GROUP
| Argument | Required | Description |
| group | yes | Group. |
Remove a role dependency.
admidio group:deldependency GROUP DEPENDENT_GROUP [--yes]
| Argument | Required | Description |
| group | yes | Parent group. |
| dependent-group | yes | Dependent child group. |
| Option | Description |
| –yes | Confirm removal. |
admidio group:delete GROUP [--yes]
| Argument | Required | Description |
| group | yes | Group. |
| Option | Description |
| –yes | Confirm deletion. |
Permanently delete one membership history row.
admidio group:deletemembership MEMBERSHIP [--yes]
| Argument | Required | Description |
| membership | yes | Membership UUID/id. |
| Option | Description |
| –yes | Confirm permanent history deletion. |
End a current group membership using Role::stopMembership().
admidio group:deluser GROUP USER [--date=DATE]
| Argument | Required | Description |
| group | yes | Group. |
| user | yes | User. |
| Option | Description |
| –date=DATE | Last day of the membership. Without this option the membership is ended as of today. |
List parent/child role dependencies.
admidio group:dependencies GROUP [--format=FORMAT]
| Argument | Required | Description |
| group | yes | Group. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Export group members as vCards.
admidio group:export GROUP [--output=FILE]
| Argument | Required | Description |
| group | yes | Group. |
admidio group:list [--category=CATEGORY] [--active=BOOL] [--format=FORMAT]
| Option | Description |
| –category=CATEGORY | Role category. |
| –active=BOOL | Filter rol_valid. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
admidio group:members GROUP [--date=DATE] [--active] [--former] [--future] [--leaders] [--format=FORMAT]
| Argument | Required | Description |
| group | yes | Group. |
| Option | Description |
| –date=DATE | Reference date. |
| –active | Show active memberships. |
| –former | Show former memberships. |
| –future | Show future memberships. |
| –leaders | Only leaders. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Show or change native role permission columns.
admidio group:permissions GROUP [--set=RIGHT=BOOL ...] [--format=text|json]
| Argument | Required | Description |
| group | yes | Group. |
| Option | Description |
| –set=RIGHT=BOOL … | Set a rol_* permission column. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio group:show GROUP [--members] [--permissions] [--format=text|json]
| Argument | Required | Description |
| group | yes | Group UUID/id/name. |
| Option | Description |
| –members | Include current members. |
| –permissions | Include role permission columns. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio group:update GROUP [options]
| Argument | Required | Description |
| group | yes | Group. |
| Option | Description |
| –category=CATEGORY | Role category. |
| –name=NAME | Role name. |
| –description=TEXT | Role description. |
| –mail-to-role=MODE | Who may mail this role (0-3). |
| –view-memberships=MODE | Who may view memberships (0-3). |
| –view-profiles=MODE | Who may view member profiles (0-3). |
| –leader-rights=MODE | Leader rights (0-3). |
| –default-list=LIST | Default list configuration. |
| –default-registration=BOOL | Assign role by default to registrations. |
| –max-members=N | Maximum member count. |
| –cost=NUMBER | Role cost. |
| –cost-period=PERIOD | Cost period. |
| –start=DATE | Role start date YYYY-MM-DD. |
| –end=DATE | Role end date YYYY-MM-DD. |
| –start-time=TIME | Role start time HH:MM. |
| –end-time=TIME | Role end time HH:MM. |
| –weekday=DAY | Weekday number. |
| –location=TEXT | Meeting location. |
Update an existing membership period/leader status.
admidio group:updateuser GROUP USER [--start=DATE] [--end=DATE] [--leader=BOOL] [--force-period=BOOL]
| Argument | Required | Description |
| group | yes | Group. |
| user | yes | User. |
| Option | Description |
| –start=DATE | Membership start date. |
| –end=DATE | Membership end date. |
| –leader=BOOL | Leader status. |
| –force-period=BOOL | Write exactly the given period instead of merging it with an adjacent one. Defaults to true. |
Show command help. Markdown and native DokuWiki output can be generated from the registry.
admidio help [COMMAND] [--all] [--format=text|md|dokuwiki|json] [--output=FILE]
| Argument | Required | Description |
| command | no | Command whose help should be displayed. |
| Option | Description |
| –all | Render documentation for all registered commands. |
| –format=FORMAT | Help format. Possible values: text, md, dokuwiki, json. |
admidio help group:adduser
admidio help --all --format=md
admidio help --all --format=dokuwiki
Remove the Admidio .htaccess protection file.
admidio htaccess:disable [--yes]
| Option | Description |
| –yes | Confirm removal of protection. |
Protect adm_my_files through the native Htaccess helper.
Show whether adm_my_files is protected by an .htaccess file. Exits with 3 if it is unprotected.
admidio htaccess:status [--format=text|json]
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Check all values and prerequisites of a new installation without changing anything. Missing values are asked for.
admidio install:check --db-type=TYPE --db-host=HOST --db-name=NAME --db-user=USER --root-url=URL --organization-shortname=NAME --organization-name=NAME --organization-email=EMAIL --admin-login=LOGIN --admin-first-name=NAME --admin-last-name=NAME --admin-email=EMAIL [options]
| Option | Description |
| –db-type=TYPE | Database system. Required without an existing configuration file. Possible values: mariadb, mysql, pgsql. |
| –db-host=HOST | Host name or IP address of the database server. |
| –db-port=PORT | Port of the database server. Empty for the default port of the database system. |
| –db-name=NAME | Name of the database. |
| –db-user=USER | User of the database. |
| –db-password=PASSWORD | Password of the database user. Prefer –db-password-stdin. |
| –db-password-stdin | Read the password of the database user from STDIN. |
| –table-prefix=PREFIX | Prefix of the Admidio tables, “adm” by default. |
| –root-url=URL | URL of this Admidio installation. Required without an existing configuration file. |
| –language=LANGUAGE | Language of the new organization, “en” by default. |
| –timezone=TIMEZONE | Time zone of the new organization. |
| –organization-shortname=NAME | Short name of the organization. |
| –organization-name=NAME | Name of the organization. |
| –organization-email=EMAIL | Email address of the organization administrator. |
| –admin-login=LOGIN | Login name of the administrator. |
| –admin-first-name=NAME | First name of the administrator. |
| –admin-last-name=NAME | Last name of the administrator. |
| –admin-email=EMAIL | Email address of the administrator. |
| –admin-password=PASSWORD | Password of the administrator. Prefer –admin-password-stdin. |
| –admin-password-stdin | Read the password of the administrator from STDIN. It is the second line if the database password is read from STDIN too. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio install:check --db-type=mariadb --db-host=localhost --db-name=admidio --db-user=admidio --db-password-stdin --root-url=https://www.example.org/admidio --timezone=Europe/Berlin --organization-shortname=EXAMPLE --organization-name="Example Organization" --organization-email=info@example.org --admin-login=admin --admin-first-name=Anna --admin-last-name=Admin --admin-email=anna@example.org --admin-password-stdin
Install a new Admidio database with its first organization and administrator. Missing values are asked for, –no-interaction requires all of them as options.
admidio install:run --db-type=TYPE --db-host=HOST --db-name=NAME --db-user=USER --root-url=URL --organization-shortname=NAME --organization-name=NAME --organization-email=EMAIL --admin-login=LOGIN --admin-first-name=NAME --admin-last-name=NAME --admin-email=EMAIL [options] [--yes]
| Option | Description |
| –db-type=TYPE | Database system. Required without an existing configuration file. Possible values: mariadb, mysql, pgsql. |
| –db-host=HOST | Host name or IP address of the database server. |
| –db-port=PORT | Port of the database server. Empty for the default port of the database system. |
| –db-name=NAME | Name of the database. |
| –db-user=USER | User of the database. |
| –db-password=PASSWORD | Password of the database user. Prefer –db-password-stdin. |
| –db-password-stdin | Read the password of the database user from STDIN. |
| –table-prefix=PREFIX | Prefix of the Admidio tables, “adm” by default. |
| –root-url=URL | URL of this Admidio installation. Required without an existing configuration file. |
| –language=LANGUAGE | Language of the new organization, “en” by default. |
| –timezone=TIMEZONE | Time zone of the new organization. |
| –organization-shortname=NAME | Short name of the organization. |
| –organization-name=NAME | Name of the organization. |
| –organization-email=EMAIL | Email address of the organization administrator. |
| –admin-login=LOGIN | Login name of the administrator. |
| –admin-first-name=NAME | First name of the administrator. |
| –admin-last-name=NAME | Last name of the administrator. |
| –admin-email=EMAIL | Email address of the administrator. |
| –admin-password=PASSWORD | Password of the administrator. Prefer –admin-password-stdin. |
| –admin-password-stdin | Read the password of the administrator from STDIN. It is the second line if the database password is read from STDIN too. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
| –yes | Confirm the installation. |
admidio install:run --db-type=mariadb --db-host=localhost --db-name=admidio --db-user=admidio --db-password-stdin --root-url=https://www.example.org/admidio --timezone=Europe/Berlin --organization-shortname=EXAMPLE --organization-name="Example Organization" --organization-email=info@example.org --admin-login=admin --admin-first-name=Anna --admin-last-name=Admin --admin-email=anna@example.org --admin-password-stdin --yes
Create an inventory item.
admidio inventory:add --field=FIELD=VALUE ...
| Option | Description |
| –field=FIELD=VALUE … | Inventory field assignment. |
Assign an inventory item to a receiver.
admidio inventory:checkout ITEM --user=USER [--date=DATE]
| Argument | Required | Description |
| item | yes | Item. |
| Option | Description |
| –user=USER | Receiver user. |
| –date=DATE | Borrow date. |
admidio inventory:copy ITEM [--copies=N] [--number-field=FIELD] [--field=FIELD=VALUE ...]
| Argument | Required | Description |
| item | yes | Item. |
| Option | Description |
| –copies=N | Number of copies. |
| –number-field=FIELD | Numeric inventory field to increment for copied items. |
| –field=FIELD=VALUE … | Inventory field assignment. |
Delete inventory items using ItemService::delete().
admidio inventory:delete ITEM ... [--yes]
| Argument | Required | Description |
| item | yes | One or more items. |
| Option | Description |
| –yes | Confirm deletion. |
admidio inventory:export --format=FORMAT [--output=FILE]
| Option | Description |
| –format=FORMAT | Export format. Possible values: xlsx, ods, csv-ms, csv-oo, pdf, pdfl. |
Create an inventory field.
admidio inventory:field-add --name=NAME --type=TYPE [options]
| Option | Description |
| –name=NAME | Field name. |
| –type=TYPE | Field type. Possible values: CATEGORY, CHECKBOX, DATE, DECIMAL, DROPDOWN, DROPDOWN_MULTISELECT, DROPDOWN_DATE_INTERVAL, EMAIL, NUMBER, PHONE, RADIO_BUTTON, TEXT, TEXT_BIG, URL. |
| –connected-field=FIELD | Connected DATE field. |
| –required=MODE | Mandatory-field mode. Possible values: 0, 1. |
| –description=TEXT | Field description. |
Delete an inventory field using ItemFieldService::delete().
admidio inventory:field-delete FIELD [--yes]
| Argument | Required | Description |
| field | yes | Inventory field. |
| Option | Description |
| –yes | Confirm deletion. |
admidio inventory:field-move FIELD up|down
| Argument | Required | Description |
| field | yes | Inventory field. |
| direction | yes | up or down. |
Show an inventory field definition.
admidio inventory:field-show FIELD [--format=text|json]
| Argument | Required | Description |
| field | yes | Inventory field UUID/id/internal name. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update an inventory field.
admidio inventory:field-update FIELD [options]
| Argument | Required | Description |
| field | yes | Inventory field. |
| Option | Description |
| –name=NAME | Field name. |
| –type=TYPE | Field type. Possible values: CATEGORY, CHECKBOX, DATE, DECIMAL, DROPDOWN, DROPDOWN_MULTISELECT, DROPDOWN_DATE_INTERVAL, EMAIL, NUMBER, PHONE, RADIO_BUTTON, TEXT, TEXT_BIG, URL. |
| –connected-field=FIELD | Connected DATE field. |
| –required=MODE | Mandatory-field mode. Possible values: 0, 1. |
| –description=TEXT | Field description. |
List inventory field definitions.
admidio inventory:fields [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Import inventory items from a spreadsheet or delimited file.
admidio inventory:import FILE [options]
| Argument | Required | Description |
| file | yes | Import file. |
| Option | Description |
| –input-format=FORMAT | Input file format. Possible values: AUTO, XLSX, XLS, ODS, CSV, HTML. |
| –encoding=ENCODING | CSV input encoding. Possible values: GUESS, UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, CP1252, ISO-8859-1. |
| –separator=SEPARATOR | CSV separator. Possible values: auto, comma, semicolon, tab, pipe. |
| –enclosure=ENCLOSURE | CSV field enclosure. Possible values: auto, none, double, single. |
| –sheet=SHEET | Worksheet name or zero-based index. |
| –first-row=BOOL | Whether the first row contains column names. Defaults to true. |
| –map=FIELD=COLUMN … | Map an inventory field to a one-based column number or header: FIELD=COLUMN. |
Preview an inventory import: report the resolved field mapping and the number of items without writing anything.
admidio inventory:import-check FILE [options] [--format=text|json]
| Argument | Required | Description |
| file | yes | Import file. |
| Option | Description |
| –input-format=FORMAT | Input file format. Possible values: AUTO, XLSX, XLS, ODS, CSV, HTML. |
| –encoding=ENCODING | CSV input encoding. Possible values: GUESS, UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, CP1252, ISO-8859-1. |
| –separator=SEPARATOR | CSV separator. Possible values: auto, comma, semicolon, tab, pipe. |
| –enclosure=ENCLOSURE | CSV field enclosure. Possible values: auto, none, double, single. |
| –sheet=SHEET | Worksheet name or zero-based index. |
| –first-row=BOOL | Whether the first row contains column names. Defaults to true. |
| –map=FIELD=COLUMN … | Map an inventory field to a one-based column number or header: FIELD=COLUMN. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio inventory:list [--search=TEXT] [--category=CATEGORY] [--status=active|retired|all] [--format=FORMAT]
| Option | Description |
| –search=TEXT | Search item data. |
| –category=CATEGORY | Inventory category. |
| –status=STATUS | Item status. Possible values: active, retired, all. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
admidio inventory:option-add FIELD VALUE
| Argument | Required | Description |
| field | yes | Inventory field. |
| value | yes | Option value. |
Delete a select option if unused.
admidio inventory:option-delete FIELD OPTION [--yes]
| Argument | Required | Description |
| field | yes | Inventory field. |
| option | yes | Option id. |
| Option | Description |
| –yes | Confirm deletion. |
admidio inventory:option-move FIELD OPTION up|down
| Argument | Required | Description |
| field | yes | Inventory field. |
| option | yes | Option id. |
| direction | yes | up or down. |
admidio inventory:option-update FIELD OPTION [--value=VALUE] [--obsolete=BOOL]
| Argument | Required | Description |
| field | yes | Inventory field. |
| option | yes | Option id. |
| Option | Description |
| –value=VALUE | Option value. |
| –obsolete=BOOL | Obsolete flag. |
List select options for an inventory field.
admidio inventory:options FIELD [--include-obsolete] [--format=FORMAT]
| Argument | Required | Description |
| field | yes | Inventory field. |
| Option | Description |
| –include-obsolete | Include obsolete options. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Delete the picture of an inventory item.
admidio inventory:picture-delete ITEM [--yes]
| Argument | Required | Description |
| item | yes | Item. |
| Option | Description |
| –yes | Confirm deletion. |
Export the picture of an inventory item.
admidio inventory:picture-get ITEM [--output=FILE]
| Argument | Required | Description |
| item | yes | Item. |
Set the picture of an inventory item.
admidio inventory:picture-set ITEM FILE
| Argument | Required | Description |
| item | yes | Item. |
| file | yes | JPEG/PNG image file. |
Reinstate retired inventory items.
admidio inventory:reinstate ITEM ...
| Argument | Required | Description |
| item | yes | One or more items. |
Retire inventory items using ItemService::retireItem().
admidio inventory:retire ITEM ...
| Argument | Required | Description |
| item | yes | One or more items. |
Return a checked-out inventory item.
admidio inventory:return ITEM [--date=DATE]
| Argument | Required | Description |
| item | yes | Item. |
| Option | Description |
| –date=DATE | Return date. |
Show an inventory item and its configured field values.
admidio inventory:show ITEM [--format=text|json]
| Argument | Required | Description |
| item | yes | Item UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update an inventory item.
admidio inventory:update ITEM [--field=FIELD=VALUE ...]
| Argument | Required | Description |
| item | yes | Item. |
| Option | Description |
| –field=FIELD=VALUE … | Inventory field assignment. |
admidio link:add --name=NAME --url=URL --category=CATEGORY [--description=TEXT]
| Option | Description |
| –name=NAME | Link name. |
| –url=URL | URL. |
| –category=CATEGORY | Link category. |
| –description=TEXT | Description. |
admidio link:delete LINK [--yes]
| Argument | Required | Description |
| link | yes | Link. |
| Option | Description |
| –yes | Confirm deletion. |
admidio link:list [--category=CATEGORY] [--format=FORMAT]
| Option | Description |
| –category=CATEGORY | Link category. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Move a web link one position in its category.
admidio link:move LINK up|down
| Argument | Required | Description |
| link | yes | Link. |
| direction | yes | up or down. |
admidio link:show LINK [--format=text|json]
| Argument | Required | Description |
| link | yes | Link UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio link:update LINK [options]
| Argument | Required | Description |
| link | yes | Link. |
| Option | Description |
| –name=NAME | Link name. |
| –url=URL | URL. |
| –category=CATEGORY | Link category. |
| –description=TEXT | Description. |
List registered CLI commands.
admidio list [NAMESPACE] [--format=table|json|csv|md|dokuwiki]
| Argument | Required | Description |
| namespace | no | Optional command namespace. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Create a saved member-list configuration.
admidio list:add NAME [--global=BOOL] --column=COLUMN ... [--condition=...] [--sort=...]
| Argument | Required | Description |
| name | yes | List name. |
| Option | Description | |
| –name=NAME | List name. | |
| –global=BOOL | Make list available organization-wide. | |
| –column=COLUMN … | Column field id/internal name/special field. | |
| –condition=COLUMN=EXPRESSION … | Column filter COLUMN=EXPRESSION. | |
| –sort=COLUMN:DIRECTION … | Sort COLUMN:asc\ | desc. |
Copy a saved member-list configuration.
admidio list:copy LIST --name=NAME [--global=BOOL]
| Argument | Required | Description |
| list | yes | Source list. |
| Option | Description |
| –name=NAME | Name of the copied list. |
| –global=BOOL | Global/private flag. |
Delete a saved member-list configuration.
admidio list:delete LIST [--yes]
| Argument | Required | Description |
| list | yes | List UUID/id. |
| Option | Description |
| –yes | Confirm deletion. |
Render a saved member list to CSV/XLSX/ODS/PDF.
admidio list:export LIST --role=GROUP ... [--relation-type=TYPE ...] [--date-from=DATE] [--date-to=DATE] [--members=active|former|all] --format=csv|xlsx|ods|pdf [--output=FILE]
| Argument | Required | Description |
| list | yes | List UUID/id. |
| Option | Description |
| –role=GROUP … | Role/group whose members should be exported. |
| –relation-type=TYPE … | User relation type UUID/id. |
| –date-from=DATE | Membership range start. |
| –date-to=DATE | Membership range end. |
| –members=STATE | Membership state. Possible values: active, former, all. |
| –format=FORMAT | Export format. Possible values: csv, xlsx, ods, pdf. |
List saved member-list configurations.
admidio list:list [--global=BOOL] [--format=FORMAT]
| Option | Description |
| –global=BOOL | Filter global/private lists. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Show a saved member-list configuration.
admidio list:show LIST [--format=text|json]
| Argument | Required | Description |
| list | yes | List UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update a saved member-list configuration.
admidio list:update LIST [options]
| Argument | Required | Description |
| list | yes | List UUID/id. |
| Option | Description | |
| –name=NAME | List name. | |
| –global=BOOL | Make list available organization-wide. | |
| –column=COLUMN … | Column field id/internal name/special field. | |
| –condition=COLUMN=EXPRESSION … | Column filter COLUMN=EXPRESSION. | |
| –sort=COLUMN:DIRECTION … | Sort COLUMN:asc\ | desc. |
maintenance:mode
Enable, disable or query the application-wide maintenance mode.
admidio maintenance:mode [MODE] [--title=TITLE] [--message=MESSAGE] [--retry-after=SECONDS] [--allow-script=SCRIPT]... [--owner=OWNER] [--force] [--format=record|json]
| Argument | Required | Description |
| mode | no | Operation to perform: enable, disable or status. Defaults to status. |
| Option | Description |
| –title=TITLE | Title shown on the maintenance page. |
| –message=MESSAGE | Message shown on the maintenance page. |
| –retry-after=SECONDS | Retry-After interval in seconds. |
| –allow-script=SCRIPT … | Relative script path that may bypass maintenance mode. |
| –owner=OWNER | Maintenance owner identifier. Defaults to “cli”. |
| –force | Disable maintenance mode regardless of its owner. |
| –format=FORMAT | Output format. Possible values: record, json. |
admidio maintenance:mode
admidio maintenance:mode status
admidio maintenance:mode enable --message="Maintenance in progress" --retry-after=300 --yes
admidio maintenance:mode disable
admidio maintenance:mode disable --force
maintenance:repair-categories
Run the native category repair operation.
admidio maintenance:repair-categories [--yes]
| Option | Description |
| –yes | Confirm the repair. |
maintenance:repair-documents
Run the native documents/files path repair operation.
admidio maintenance:repair-documents [--yes]
| Option | Description |
| –yes | Confirm the repair. |
admidio menu:add NAME [options]
| Argument | Required | Description |
| name | yes | Menu name. |
| Option | Description |
| –name=NAME | Menu name. |
| –description=TEXT | Description. |
| –parent=MENU | Parent menu UUID/id. |
| –component=COMPONENT | Component internal name. |
| –view-role=GROUP … | Role allowed to see this menu item. |
| –url=URL | Absolute or relative URL. |
| –icon=ICON | Bootstrap icon name. |
| –node=BOOL | Whether this entry is a menu node. |
admidio menu:delete MENU [--yes]
| Argument | Required | Description |
| menu | yes | Menu entry. |
| Option | Description |
| –yes | Confirm deletion. |
admidio menu:list [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Move a menu entry one position.
admidio menu:move MENU up|down
| Argument | Required | Description |
| menu | yes | Menu entry. |
| direction | yes | up or down. |
admidio menu:show MENU [--format=text|json]
| Argument | Required | Description |
| menu | yes | Menu UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio menu:update MENU [options]
| Argument | Required | Description |
| menu | yes | Menu entry. |
| Option | Description |
| –name=NAME | Menu name. |
| –description=TEXT | Description. |
| –parent=MENU | Parent menu UUID/id. |
| –component=COMPONENT | Component internal name. |
| –view-role=GROUP … | Role allowed to see this menu item. |
| –url=URL | Absolute or relative URL. |
| –icon=ICON | Bootstrap icon name. |
| –node=BOOL | Whether this entry is a menu node. |
Delete message records using Message::delete().
admidio message:delete MESSAGE ... [--yes]
| Argument | Required | Description |
| message | yes | One or more messages. |
| Option | Description |
| –yes | Confirm deletion. |
Forward an email as a new email.
admidio message:forward MESSAGE (--user=USER|--group=GROUP) [options]
| Argument | Required | Description |
| message | yes | Source email. |
| Option | Description |
| –user=USER … | Recipient user. |
| –group=GROUP … | Recipient group; active members are addressed. |
| –subject=TEXT | Override the original subject. |
| –body=TEXT | Message body. |
| –body-file=FILE | Read body from file. |
| –attachment=FILE … | Attachment path. |
| –carbon-copy=BOOL | Send a copy to the acting user. |
| –delivery-confirmation=BOOL | Request an email read confirmation where allowed. |
Retrieve a message attachment.
admidio message:get-attachment ATTACHMENT [--output=FILE]
| Argument | Required | Description |
| attachment | yes | Attachment UUID. |
List messages involving the acting user.
admidio message:list [--type=email|pm] [--limit=N] [--offset=N] [--format=FORMAT]
| Option | Description |
| –type=TYPE | Message type. Possible values: email, pm. |
| –limit=N | Maximum records. |
| –offset=N | Result offset. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
List attachments of a message.
admidio message:list-attachments MESSAGE [--format=FORMAT]
| Argument | Required | Description |
| message | yes | Message. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Reply to a private-message conversation.
admidio message:reply MESSAGE (--body=TEXT|--body-file=FILE)
| Argument | Required | Description |
| message | yes | Private-message conversation. |
| Option | Description |
| –body=TEXT | Message body. |
| –body-file=FILE | Read body from file. |
Send email/private message using the native Message/Email recipient rules.
admidio message:send --type=email|pm [recipients] --subject=TEXT (--body=TEXT|--body-file=FILE)
| Option | Description |
| –type=TYPE | Email or private message. Possible values: email, pm. |
| –user=USER … | Recipient user. |
| –group=GROUP … | Recipient group; active members are addressed. |
| –subject=TEXT | Message subject. |
| –body=TEXT | Message body. |
| –body-file=FILE | Read body from file. |
| –attachment=FILE … | Attachment path. |
| –carbon-copy=BOOL | Send a copy of an email to the acting user. |
| –delivery-confirmation=BOOL | Request an email read confirmation where allowed. |
Show a message/conversation entry.
admidio message:show MESSAGE [--format=text|json]
| Argument | Required | Description |
| message | yes | Message UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
List module namespaces represented by registered commands.
admidio module:list [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
List registered tasks, optionally restricted to one namespace.
admidio module:tasks [MODULE] [--format=FORMAT]
| Argument | Required | Description |
| module | no | Optional module namespace. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Create a suborganization with native basic data and preferences.
admidio organization:add --short-name=NAME --name=NAME --email=EMAIL [options]
| Option | Description |
| –short-name=NAME | Organization short name. |
| –name=NAME | Organization long name. |
| –email=EMAIL | Administrator email address. |
| –homepage=URL | Organization homepage. |
| –parent=ORG | Parent organization. |
| –show-organization-select=BOOL | Show organization selection at login. |
| –share-members=BOOL | Set contacts_suborganization_use_same_members on the PARENT organization, so its suborganizations share its members. |
Delete an organization using Organization::delete().
admidio organization:delete ORG [--yes]
| Argument | Required | Description |
| org | yes | Organization UUID, id or unique short name. |
| Option | Description |
| –yes | Confirm deletion. |
admidio organization:list [--format=table|json|csv|md|dokuwiki]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
admidio organization:show ORG [--format=text|json]
| Argument | Required | Description |
| org | yes | Organization UUID, id or unique short name. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update organization properties.
admidio organization:update ORG [options]
| Argument | Required | Description |
| org | yes | Organization UUID, id or unique short name. |
| Option | Description |
| –short-name=NAME | Organization short name. |
| –name=NAME | Organization long name. |
| –email=EMAIL | Administrator email address. |
| –homepage=URL | Organization homepage. |
| –parent=ORG | Parent organization. |
| –show-organization-select=BOOL | Show organization selection at login. |
| –share-members=BOOL | Set contacts_suborganization_use_same_members on the PARENT organization, so its suborganizations share its members. |
Add role assignments for an object right.
admidio permissions:add RIGHT_TYPE OBJECT_ID --role=GROUP ...
| Argument | Required | Description |
| right-type | yes | Roles-right name. |
| object-id | yes | Numeric object id. |
| Option | Description |
| –role=GROUP … | Role/group. |
Remove all role assignments from an object right.
admidio permissions:clear RIGHT_TYPE OBJECT_ID [--yes]
| Argument | Required | Description |
| right-type | yes | Roles-right name. |
| object-id | yes | Numeric object id. |
| Option | Description |
| –yes | Confirm removal. |
List RolesRights assignments.
admidio permissions:list [--type=RIGHT_TYPE] [--format=FORMAT]
| Option | Description |
| –type=RIGHT_TYPE | Roles-right name. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Remove role assignments for an object right.
admidio permissions:remove RIGHT_TYPE OBJECT_ID --role=GROUP ...
| Argument | Required | Description |
| right-type | yes | Roles-right name. |
| object-id | yes | Numeric object id. |
| Option | Description |
| –role=GROUP … | Role/group. |
Set role assignments for an object right.
admidio permissions:set RIGHT_TYPE OBJECT_ID --role=GROUP ...
| Argument | Required | Description |
| right-type | yes | Roles-right name. |
| object-id | yes | Numeric object id. |
| Option | Description |
| –role=GROUP … | Role/group. |
Show roles assigned to an object right.
admidio permissions:show RIGHT_TYPE OBJECT_ID [--format=text|json]
| Argument | Required | Description |
| right-type | yes | Roles-right name. |
| object-id | yes | Numeric object id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio photo:album-add NAME --begin=DATE [options]
| Argument | Required | Description |
| name | yes | Album name. |
| Option | Description |
| –name=NAME | Album name. |
| –parent=ALBUM | Parent album or ALL for a root album. |
| –begin=DATE | Begin date. |
| –end=DATE | End date. |
| –photographers=TEXT | Photographers. |
| –description=TEXT | Description. |
| –locked=BOOL | Album locked flag. |
Delete a photo album through Album::delete().
admidio photo:album-delete ALBUM [--yes]
| Argument | Required | Description |
| album | yes | Album. |
| Option | Description |
| –yes | Confirm deletion. |
Download all photos of an album as ZIP.
admidio photo:album-download ALBUM [--output=FILE]
| Argument | Required | Description |
| album | yes | Album. |
admidio photo:album-lock ALBUM
| Argument | Required | Description |
| album | yes | Album. |
admidio photo:album-show ALBUM [--format=text|json]
| Argument | Required | Description |
| album | yes | Album UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio photo:album-unlock ALBUM
| Argument | Required | Description |
| album | yes | Album. |
admidio photo:album-update ALBUM [options]
| Argument | Required | Description |
| album | yes | Album. |
| Option | Description |
| –name=NAME | Album name. |
| –parent=ALBUM | Parent album or ALL for a root album. |
| –begin=DATE | Begin date. |
| –end=DATE | End date. |
| –photographers=TEXT | Photographers. |
| –description=TEXT | Description. |
| –locked=BOOL | Album locked flag. |
Delete one or more photos from an album.
admidio photo:delete ALBUM PHOTO_NUMBER ... [--yes]
| Argument | Required | Description |
| album | yes | Album. |
| photo-number | yes | One or more photo numbers. |
| Option | Description |
| –yes | Confirm deletion. |
admidio photo:download ALBUM PHOTO_NUMBER [--output=FILE]
| Argument | Required | Description |
| album | yes | Album. |
| photo-number | yes | Photo number. |
admidio photo:ecard-send ALBUM PHOTO_NUMBER --template=TEMPLATE (--user=USER|--group=GROUP) (--message=TEXT|--message-file=FILE)
| Argument | Required | Description |
| album | yes | Album. |
| photo-number | yes | Photo number. |
| Option | Description |
| –template=TEMPLATE | E-card template filename. |
| –user=USER … | Recipient user. |
| –group=GROUP … | Recipient group; active members are addressed. |
| –message=TEXT | E-card message. |
| –message-file=FILE | Read the e-card message from a file. |
photo:ecard-send ALBUM 1 --template=default.tpl --user=john --message="Best wishes!" --as=admin
List available e-card templates.
admidio photo:ecard-templates [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
admidio photo:list [--parent=ALBUM] [--format=FORMAT]
| Option | Description |
| –parent=ALBUM | Parent album or ALL for a root album. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Rotate a photo by 90 degrees.
admidio photo:rotate ALBUM PHOTO_NUMBER --direction=left|right
| Argument | Required | Description |
| album | yes | Album. |
| photo-number | yes | Photo number. |
| Option | Description |
| –direction=DIRECTION | Rotation direction. Possible values: left, right. |
Upload one or more local image files to an album.
admidio photo:upload ALBUM FILE ...
| Argument | Required | Description |
| album | yes | Album. |
| file | yes | JPEG/PNG image file. |
Install a current-interface plugin.
admidio plugin:install PLUGIN [--add-menu=BOOL]
| Argument | Required | Description |
| plugin | yes | Plugin name. |
| Option | Description |
| –add-menu=BOOL | Add plugin menu entry. |
List discovered plugins and installation/update state.
admidio plugin:list [--installed] [--updates] [--format=FORMAT]
| Option | Description |
| –installed | Only installed plugins. |
| –updates | Only plugins with updates. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
admidio plugin:move PLUGIN up|down
| Argument | Required | Description |
| plugin | yes | Plugin name. |
| direction | yes | up or down. |
Uninstall a current-interface plugin.
admidio plugin:remove PLUGIN [--remove-menu=BOOL] [--yes]
| Argument | Required | Description |
| plugin | yes | Plugin name. |
| Option | Description |
| –remove-menu=BOOL | Remove plugin menu entry. |
| –yes | Confirm uninstall. |
Show plugin metadata/state.
admidio plugin:show PLUGIN [--format=text|json]
| Argument | Required | Description |
| plugin | yes | Plugin name. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio plugin:update PLUGIN
| Argument | Required | Description |
| plugin | yes | Plugin name. |
admidio profile:field-add --name=NAME --category=CATEGORY --type=TYPE [options]
The acting user selected with –as must be an Admidio administrator.
| Option | Description |
| –name=NAME | Field name. |
| –category=CATEGORY | Profile-field category. |
| –type=TYPE | Field type. Possible values: CHECKBOX, DATE, DECIMAL, DROPDOWN, DROPDOWN_MULTISELECT, EMAIL, NUMBER, PHONE, RADIO_BUTTON, TEXT, TEXT_BIG, URL. |
| –required=MODE | Mandatory-field mode. Possible values: 0, 1, 2, 3. |
| –hidden=BOOL | Hidden field flag. |
| –disabled=BOOL | Disabled field flag. |
| –registration=BOOL | Show field during registration. |
| –default=VALUE | Default value. |
| –regex=REGEX | Regular expression. |
| –icon=ICON | Bootstrap icon. |
| –url=URL | URL template. |
| –description=TEXT | Field description. |
Delete a profile field through ProfileField::delete().
admidio profile:field-delete FIELD [--yes]
| Argument | Required | Description |
| field | yes | Profile field. |
| Option | Description |
| –yes | Confirm deletion. |
admidio profile:field-move FIELD up|down
| Argument | Required | Description |
| field | yes | Profile field. |
| direction | yes | up or down. |
Show a profile field definition.
admidio profile:field-show FIELD [--format=text|json]
| Argument | Required | Description |
| field | yes | Profile field UUID/id/internal name. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
admidio profile:field-update FIELD [options]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| field | yes | Profile field. |
| Option | Description |
| –name=NAME | Field name. |
| –category=CATEGORY | Profile-field category. |
| –type=TYPE | Field type. Possible values: CHECKBOX, DATE, DECIMAL, DROPDOWN, DROPDOWN_MULTISELECT, EMAIL, NUMBER, PHONE, RADIO_BUTTON, TEXT, TEXT_BIG, URL. |
| –required=MODE | Mandatory-field mode. Possible values: 0, 1, 2, 3. |
| –hidden=BOOL | Hidden field flag. |
| –disabled=BOOL | Disabled field flag. |
| –registration=BOOL | Show field during registration. |
| –default=VALUE | Default value. |
| –regex=REGEX | Regular expression. |
| –icon=ICON | Bootstrap icon. |
| –url=URL | URL template. |
| –description=TEXT | Field description. |
List profile field definitions.
admidio profile:fields [--category=CATEGORY] [--format=FORMAT]
| Option | Description |
| –category=CATEGORY | Profile-field category. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Add a profile select option.
admidio profile:option-add FIELD VALUE
| Argument | Required | Description |
| field | yes | Profile field. |
| value | yes | Option value. |
Delete an unused profile select option.
admidio profile:option-delete FIELD OPTION [--yes]
| Argument | Required | Description |
| field | yes | Profile field. |
| option | yes | Option id. |
| Option | Description |
| –yes | Confirm deletion. |
Move a profile select option.
admidio profile:option-move FIELD OPTION up|down
| Argument | Required | Description |
| field | yes | Profile field. |
| option | yes | Option id. |
| direction | yes | up or down. |
Update a profile select option.
admidio profile:option-update FIELD OPTION [--value=VALUE] [--obsolete=BOOL]
| Argument | Required | Description |
| field | yes | Profile field. |
| option | yes | Option id. |
| Option | Description |
| –value=VALUE | Option value. |
| –obsolete=BOOL | Obsolete flag. |
List select options of a profile field.
admidio profile:options FIELD [--include-obsolete] [--format=FORMAT]
| Argument | Required | Description |
| field | yes | Profile field. |
| Option | Description |
| –include-obsolete | Include obsolete options. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
Approve a registration using UserRegistration::acceptRegistration().
admidio registration:approve USER [--group=GROUP ...]
| Argument | Required | Description |
| user | yes | Registration user. |
| Option | Description |
| –group=GROUP … | Additional group after approval. |
Assign a pending registration to an existing user using RegistrationService.
admidio registration:assign REGISTRATION_USER EXISTING_USER [--existing-member=BOOL]
| Argument | Required | Description |
| registration-user | yes | Pending registration user. |
| existing-user | yes | Existing user. |
| Option | Description |
| –existing-member=BOOL | Existing user is already a member of the current organization. |
Confirm a registration validation id.
admidio registration:confirm USER VALIDATION_ID
| Argument | Required | Description |
| user | yes | Registration user UUID. |
| validation-id | yes | Registration validation id. |
Alias for registration:approve.
admidio registration:create-user USER [--group=GROUP ...]
This command is another name for registration:approve and behaves identically.
| Argument | Required | Description |
| user | yes | Registration user. |
| Option | Description |
| –group=GROUP … | Additional group after approval. |
Delete a pending registration.
admidio registration:delete USER [--yes]
| Argument | Required | Description |
| user | yes | Registration user. |
| Option | Description |
| –yes | Confirm deletion. |
List pending registrations.
admidio registration:list [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Send login data to the matched existing user.
admidio registration:send-login REGISTRATION_USER EXISTING_USER
| Argument | Required | Description |
| registration-user | yes | Pending registration user. |
| existing-user | yes | Existing user. |
Show a pending registration.
admidio registration:show USER [--format=text|json]
| Argument | Required | Description |
| user | yes | Registration user UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Search native similar-user matches for a registration.
admidio registration:similar USER [--format=FORMAT]
| Argument | Required | Description |
| user | yes | Registration user. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, md. |
Create a user relation type.
admidio relation-type:add --name=NAME --type=TYPE [options]
The acting user selected with –as must be an Admidio administrator.
| Option | Description |
| –name=NAME | Relation name. |
| –type=TYPE | Relation shape. Possible values: symmetrical, asymmetrical, unidirectional. |
| –name-male=NAME | Male-specific name. |
| –name-female=NAME | Female-specific name. |
| –editable-by-user=BOOL | Whether users may edit this relation. |
| –inverse-name=NAME | Inverse relation name (asymmetrical types only). |
| –inverse-name-male=NAME | Male-specific inverse relation name. |
| –inverse-name-female=NAME | Female-specific inverse relation name. |
| –inverse-editable-by-user=BOOL | Whether users may edit the inverse relation. |
Delete a user relation type.
admidio relation-type:delete TYPE [--yes]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| type | yes | Relation type UUID/id. |
| Option | Description |
| –yes | Confirm deletion. |
List user relation types.
admidio relation-type:list [--format=FORMAT]
| Option | Description |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Show a user relation type.
admidio relation-type:show TYPE [--format=text|json]
| Argument | Required | Description |
| type | yes | Relation type UUID or id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update a user relation type. Its existing relation shape is retained, matching current master.
admidio relation-type:update TYPE [options]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| type | yes | Relation type UUID/id. |
| Option | Description |
| –name=NAME | Relation name. |
| –name-male=NAME | Male-specific name. |
| –name-female=NAME | Female-specific name. |
| –editable-by-user=BOOL | Whether users may edit this relation. |
| –inverse-name=NAME | Inverse relation name (asymmetrical types only). |
| –inverse-name-male=NAME | Male-specific inverse relation name. |
| –inverse-name-female=NAME | Female-specific inverse relation name. |
| –inverse-editable-by-user=BOOL | Whether users may edit the inverse relation. |
admidio relation:add USER1 USER2 TYPE
| Argument | Required | Description |
| user1 | yes | First user. |
| user2 | yes | Second user. |
| type | yes | Relation type UUID/id. |
Delete a user relation including its native inverse record.
admidio relation:delete RELATION [--yes]
| Argument | Required | Description |
| relation | yes | Relation UUID/id. |
| Option | Description |
| –yes | Confirm deletion. |
admidio relation:list [USER] [--type=TYPE] [--format=FORMAT]
| Argument | Required | Description |
| user | no | Optional user. |
| Option | Description |
| –type=TYPE | Relation type. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Delete stale PHP-session database records.
admidio session:cleanup [--max-inactive-minutes=N]
| Option | Description |
| –max-inactive-minutes=N | Inactive age threshold. |
Mark all active sessions of a user for reload.
admidio session:invalidate USER
| Argument | Required | Description |
| user | yes | User. |
Mark all active sessions for reload.
admidio session:invalidate-all [--yes]
| Option | Description |
| –yes | Confirm invalidation. |
Export an SSO certificate.
admidio sso:certificate-export KEY [--output=FILE]
| Argument | Required | Description |
| key | yes | Key UUID/id. |
Disable an SSO client using SSOClient::enable(false).
admidio sso:disable CLIENT [--type=saml|oidc]
| Argument | Required | Description |
| client | yes | Client UUID/client id. |
| Option | Description |
| –type=TYPE | Disambiguate client type. Possible values: saml, oidc. |
Enable an SSO client using SSOClient::enable().
admidio sso:enable CLIENT [--type=saml|oidc]
| Argument | Required | Description |
| client | yes | Client UUID/client id. |
| Option | Description |
| –type=TYPE | Disambiguate client type. Possible values: saml, oidc. |
Generate and store a new SSO key/certificate.
admidio sso:key-add --name=NAME --country=CODE --state=TEXT --locality=TEXT --organization-unit=TEXT [options]
| Option | Description |
| –name=NAME | Key name. |
| –algorithm=ALGORITHM | Key algorithm. Possible values: RSA, RSA-2048, RSA-3072, RSA-4096. |
| –active=BOOL | Active flag. |
| –country=CODE | Certificate country code. |
| –state=TEXT | Certificate state/province. |
| –locality=TEXT | Certificate city/locality. |
| –organization-name=TEXT | Certificate organization. |
| –organization-unit=TEXT | Certificate organization unit. |
| –common-name=TEXT | Certificate common name. |
| –admin-email=EMAIL | Certificate administrator email. |
| –expires=DATE | Certificate expiration date. |
Delete an SSO key Entity.
admidio sso:key-delete KEY [--yes]
| Argument | Required | Description |
| key | yes | Key UUID/id. |
| Option | Description |
| –yes | Confirm deletion. |
Export an SSO key as PKCS#12.
admidio sso:key-export KEY [--password=PASSWORD|--password-stdin] [--output=FILE]
| Argument | Required | Description |
| key | yes | Key UUID/id. |
| Option | Description |
| –password=PASSWORD | PKCS#12 export password. Prefer –password-stdin. |
| –password-stdin | Read export password from STDIN. |
Generate a new key and certificate.
admidio sso:key-generate --name=NAME --country=CODE --state=TEXT --locality=TEXT --organization-unit=TEXT [options]
| Option | Description |
| –name=NAME | Key name. |
| –algorithm=ALGORITHM | Key algorithm. Possible values: RSA, RSA-2048, RSA-3072, RSA-4096. |
| –active=BOOL | Active flag. |
| –country=CODE | Certificate country code. |
| –state=TEXT | Certificate state/province. |
| –locality=TEXT | Certificate city/locality. |
| –organization-name=TEXT | Certificate organization. |
| –organization-unit=TEXT | Certificate organization unit. |
| –common-name=TEXT | Certificate common name. |
| –admin-email=EMAIL | Certificate administrator email. |
| –expires=DATE | Certificate expiration date. |
Regenerate an existing key and certificate.
admidio sso:key-regenerate KEY [options] [--yes]
| Argument | Required | Description |
| key | yes | Key UUID/id. |
| Option | Description |
| –name=NAME | Key name. |
| –algorithm=ALGORITHM | Key algorithm. Possible values: RSA, RSA-2048, RSA-3072, RSA-4096. |
| –active=BOOL | Active flag. |
| –country=CODE | Certificate country code. |
| –state=TEXT | Certificate state/province. |
| –locality=TEXT | Certificate city/locality. |
| –organization-name=TEXT | Certificate organization. |
| –organization-unit=TEXT | Certificate organization unit. |
| –common-name=TEXT | Certificate common name. |
| –admin-email=EMAIL | Certificate administrator email. |
| –expires=DATE | Certificate expiration date. |
| –yes | Confirm key regeneration. |
Show SSO key metadata without private key material.
admidio sso:key-show KEY [--format=text|json]
| Argument | Required | Description |
| key | yes | Key UUID/id. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update SSO key metadata without regenerating the key.
admidio sso:key-update KEY [--name=NAME] [--active=BOOL]
| Argument | Required | Description |
| key | yes | Key UUID/id. |
| Option | Description |
| –name=NAME | Key name. |
| –active=BOOL | Active flag. |
List SSO signing/encryption keys.
admidio sso:keys [--active=BOOL] [--format=FORMAT]
| Option | Description |
| –active=BOOL | Only active keys. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
admidio sso:list [--type=saml|oidc] [--enabled=BOOL] [--format=FORMAT]
| Option | Description |
| –type=TYPE | Client type. Possible values: saml, oidc. |
| –enabled=BOOL | Enabled filter. |
| –format=FORMAT | Output format. Possible values: table, record, json, md, dokuwiki. |
admidio sso:oidc-add --name=NAME --client-id=ID [options]
| Option | Description |
| –name=NAME | Client name. |
| –client-id=ID | OIDC client id. |
| –client-secret=SECRET | New client secret. Prefer –client-secret-stdin. |
| –client-secret-stdin | Read the new client secret from STDIN. |
| –enabled=BOOL | Enabled flag. |
| –redirect-uri=URI | Redirect URI. |
| –userid-field=FIELD | Admidio user field used as subject. |
| –scope=SCOPE … | Allowed OIDC scope. |
| –field-map=ADM_FIELD=CLAIM … | Map ADM_FIELD=CLAIM. |
| –field-map-other=BOOL | Reject/unmapped other fields according to OIDC mapping mode. |
| –role-map=GROUP=CLAIM … | Map GROUP=CLAIM. |
| –role-map-other=BOOL | Include all other role memberships. |
| –access-role=GROUP … | Role/group allowed to use this client. |
Delete an OIDC client using the native OIDCClient entity.
admidio sso:oidc-delete CLIENT [--yes]
| Argument | Required | Description |
| client | yes | OIDC client UUID/client id. |
| Option | Description |
| –yes | Confirm deletion. |
Render OIDC discovery metadata.
admidio sso:oidc-discovery [--format=json] [--output=FILE]
| Option | Description |
| –format=FORMAT | Output format. Possible values: json. |
admidio sso:oidc-update CLIENT [options]
| Argument | Required | Description |
| client | yes | OIDC client UUID/client id. |
| Option | Description |
| –name=NAME | Client name. |
| –client-id=ID | OIDC client id. |
| –client-secret=SECRET | New client secret. Prefer –client-secret-stdin. |
| –client-secret-stdin | Read the new client secret from STDIN. |
| –enabled=BOOL | Enabled flag. |
| –redirect-uri=URI | Redirect URI. |
| –userid-field=FIELD | Admidio user field used as subject. |
| –scope=SCOPE … | Allowed OIDC scope. |
| –field-map=ADM_FIELD=CLAIM … | Map ADM_FIELD=CLAIM. |
| –field-map-other=BOOL | Reject/unmapped other fields according to OIDC mapping mode. |
| –role-map=GROUP=CLAIM … | Map GROUP=CLAIM. |
| –role-map-other=BOOL | Include all other role memberships. |
| –access-role=GROUP … | Role/group allowed to use this client. |
admidio sso:saml-add --name=NAME --client-id=ID --acs-url=URL [options]
| Option | Description |
| –name=NAME | Client name. |
| –client-id=ID | SAML service-provider entity/client id. |
| –enabled=BOOL | Enabled flag. |
| –metadata-url=URL | Service-provider metadata URL. |
| –acs-url=URL | Assertion Consumer Service URL. |
| –slo-url=URL | Single Logout Service URL. |
| –certificate=FILE | X.509 certificate PEM file. |
| –require-auth-signed=BOOL | Require signed AuthnRequests. |
| –sign-assertions=BOOL | Sign assertions. |
| –encrypt-assertions=BOOL | Encrypt assertions. |
| –validate-signatures=BOOL | Validate request signatures. |
| –assertion-lifetime=SECONDS | Assertion lifetime in seconds. |
| –clock-skew=SECONDS | Allowed clock skew in seconds. |
| –userid-field=FIELD | Admidio user field used as SSO subject. |
| –field-map=ADM_FIELD=SSO_FIELD … | Map ADM_FIELD=SSO_FIELD. |
| –field-map-other=BOOL | Include all other profile fields. |
| –role-map=GROUP=SSO_ROLE … | Map GROUP=SSO_ROLE. |
| –role-map-other=BOOL | Include all other role memberships. |
| –access-role=GROUP … | Role/group allowed to use this client. |
Delete a SAML client using the native SAMLClient entity.
admidio sso:saml-delete CLIENT [--yes]
| Argument | Required | Description |
| client | yes | SAML client UUID/client id. |
| Option | Description |
| –yes | Confirm deletion. |
Render SAML IdP metadata.
admidio sso:saml-metadata [--output=FILE]
admidio sso:saml-update CLIENT [options]
| Argument | Required | Description |
| client | yes | SAML client UUID/client id. |
| Option | Description |
| –name=NAME | Client name. |
| –client-id=ID | SAML service-provider entity/client id. |
| –enabled=BOOL | Enabled flag. |
| –metadata-url=URL | Service-provider metadata URL. |
| –acs-url=URL | Assertion Consumer Service URL. |
| –slo-url=URL | Single Logout Service URL. |
| –certificate=FILE | X.509 certificate PEM file. |
| –require-auth-signed=BOOL | Require signed AuthnRequests. |
| –sign-assertions=BOOL | Sign assertions. |
| –encrypt-assertions=BOOL | Encrypt assertions. |
| –validate-signatures=BOOL | Validate request signatures. |
| –assertion-lifetime=SECONDS | Assertion lifetime in seconds. |
| –clock-skew=SECONDS | Allowed clock skew in seconds. |
| –userid-field=FIELD | Admidio user field used as SSO subject. |
| –field-map=ADM_FIELD=SSO_FIELD … | Map ADM_FIELD=SSO_FIELD. |
| –field-map-other=BOOL | Include all other profile fields. |
| –role-map=GROUP=SSO_ROLE … | Map GROUP=SSO_ROLE. |
| –role-map-other=BOOL | Include all other role memberships. |
| –access-role=GROUP … | Role/group allowed to use this client. |
admidio sso:show CLIENT [--type=saml|oidc] [--format=text|json]
| Argument | Required | Description |
| client | yes | Client UUID/client id. |
| Option | Description |
| –type=TYPE | Disambiguate client type. Possible values: saml, oidc. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Delete expired/revoked OIDC token/code rows.
admidio sso:token-cleanup [--yes]
| Option | Description |
| –yes | Confirm cleanup. |
Show installation, organization and filesystem/database update status. Exits with 3 if the status is not ok.
admidio status [--format=text|json]
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Show Admidio, PHP, database and operating-system information.
admidio system:info [--format=text|json]
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Print PHP configuration information in text form.
Check the public Admidio release information used by the preferences update check. Exits with 4 if an update is available.
admidio update:check [--format=text|json]
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Create a user using native profile fields and default-role assignment.
admidio user:add --field=FIELD=VALUE ... [--login=LOGIN] [--password-stdin] [--group=GROUP ...]
| Option | Description |
| –login=LOGIN | Login name. |
| –password=PASSWORD | Password. Prefer –password-stdin. |
| –password-stdin | Read password from STDIN. |
| –field=FIELD=VALUE … | Profile field assignment INTERNAL_NAME=value. |
| –group=GROUP … | Additional role/group assignment. |
Create a new user initialized from another profile.
admidio user:copy USER [--login=LOGIN] [--field=FIELD=VALUE ...] [--group=GROUP ...]
| Argument | Required | Description |
| user | yes | Source user. |
| Option | Description |
| –login=LOGIN | Login name of the new user. |
| –field=FIELD=VALUE … | Override profile field INTERNAL_NAME=value. |
| –group=GROUP … | Group assignment for the copy. |
Permanently delete users where the native organization checks allow it.
admidio user:delete USER ... [--any-organization] [--yes]
The acting user selected with –as must be an Admidio administrator.
| Argument | Required | Description |
| user | yes | One or more users. |
| Option | Description |
| –any-organization | Also resolve users that are not members of the current organization. |
| –yes | Confirm permanent deletion. |
Export a user as the native vCard representation.
admidio user:export USER [--output=FILE]
| Argument | Required | Description |
| user | yes | User to export. |
Import contacts from a supported spreadsheet/text file.
admidio user:import FILE [options]
Unavailable: current src/Users/Entity/UserImport.php and modules/contacts/import.php implement a stateful web import workflow; there is no complete data-oriented import service to call headlessly without duplicating that workflow.
| Argument | Required | Description |
| file | yes | Import file. |
Validate and preview a contacts import.
admidio user:import-check FILE [options]
Unavailable: current src/Users/Entity/UserImport.php and modules/contacts/import.php implement a stateful web import workflow; there is no complete data-oriented import service to call headlessly without duplicating that workflow.
| Argument | Required | Description |
| file | yes | Import file. |
List users in the current organization.
admidio user:list [--search=TEXT] [--group=GROUP] [--former] [--limit=N] [--offset=N] [--format=FORMAT]
| Option | Description |
| –search=TEXT | Search login name and configured first/last name fields. |
| –group=GROUP | Restrict to members of a group. |
| –former | Include former members. |
| –limit=N | Maximum number of records. |
| –offset=N | Result offset. |
| –format=FORMAT | Output format. Possible values: table, record, json, csv, md, dokuwiki. |
Delete the user profile photo.
admidio user:photo-delete USER [--yes]
| Argument | Required | Description |
| user | yes | User. |
| Option | Description |
| –yes | Confirm deletion. |
Set the user profile photo.
admidio user:photo-set USER FILE
| Argument | Required | Description |
| user | yes | User. |
| file | yes | JPEG/PNG image file. |
End current-organization memberships so the user becomes a former member.
admidio user:remove USER ... [--yes]
| Argument | Required | Description |
| user | yes | One or more users. |
| Option | Description |
| –yes | Confirm removal. |
Alias for user:send-password.
admidio user:send-login USER
This command is another name for user:send-password and behaves identically.
| Argument | Required | Description |
| user | yes | User. |
Send the native password-reset/new-password email.
admidio user:send-password USER
| Argument | Required | Description |
| user | yes | User. |
admidio user:set-password USER [--password=PASSWORD|--password-stdin]
| Argument | Required | Description |
| user | yes | User. |
| Option | Description |
| –password=PASSWORD | New password. Prefer –password-stdin. |
| –password-stdin | Read password from STDIN. |
admidio user:show USER [--memberships] [--relations] [--format=text|json]
| Argument | Required | Description |
| user | yes | User UUID, id or unique login name. |
| Option | Description |
| –memberships | Include role memberships. |
| –relations | Include user relations. |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Remove the configured two-factor secret.
admidio user:tfa-reset USER [--yes]
| Argument | Required | Description |
| user | yes | User. |
| Option | Description |
| –yes | Confirm reset. |
Set up two-factor authentication for the acting user.
admidio user:tfa-setup USER [--secret=SECRET|--secret-stdin] [--code=CODE]
| Argument | Required | Description |
| user | yes | User. |
| Option | Description |
| –secret=SECRET | TOTP secret. Prefer –secret-stdin. If omitted, generate and print a new secret. |
| –secret-stdin | Read the TOTP secret from STDIN. |
| –code=CODE | One-time security code. If omitted, prompt interactively. |
Show whether two-factor authentication is configured.
admidio user:tfa-status USER [--format=text|json]
| Argument | Required | Description |
| user | yes | User. |
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
Update login/profile data of a user.
admidio user:update USER [--login=LOGIN] [--field=FIELD=VALUE ...]
| Argument | Required | Description |
| user | yes | User UUID, id or login name. |
| Option | Description |
| –login=LOGIN | Login name. |
| –field=FIELD=VALUE … | Profile field assignment INTERNAL_NAME=value. |
Show filesystem and installed database core version.
admidio version [--format=text|json]
| Option | Description |
| –format=FORMAT | Output format. Possible values: text, record, json. |
