Inhaltsverzeichnis

Admidio command-line utility

Note: This documentation is automatically generated by ./admidio help –all –format=dokuwiki –output=admidio-cli-commands.txt

Usage

admidio [global-options] COMMAND [arguments] [options]

Global 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.

announcement:add

Create an announcement.

Usage

admidio announcement:add --headline=TEXT --category=CATEGORY (--description=TEXT|--description-file=FILE)

Options

Option Description
–headline=TEXT Headline.
–category=CATEGORY Announcement category.
–description=TEXT HTML/text description.
–description-file=FILE Read description from file.

announcement:copy

Copy an announcement.

Usage

admidio announcement:copy ANNOUNCEMENT [--headline=TEXT] [--category=CATEGORY]

Arguments

Argument Required Description
announcement yes Source announcement.

Options

Option Description
–headline=TEXT Headline.
–category=CATEGORY Announcement category.
–description=TEXT HTML/text description.
–description-file=FILE Read description from file.

announcement:delete

Delete an announcement.

Usage

admidio announcement:delete ANNOUNCEMENT [--yes]

Arguments

Argument Required Description
announcement yes Announcement.

Options

Option Description
–yes Confirm deletion.

announcement:export-rss

Generate the announcements RSS feed.

Usage

admidio announcement:export-rss [--category=CATEGORY] [--output=FILE]

Options

Option Description
–category=CATEGORY Announcement category.

announcement:list

List announcements visible to the acting user.

Usage

admidio announcement:list [--category=CATEGORY] [--search=TEXT] [--limit=N] [--offset=N] [--format=FORMAT]

Options

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.

announcement:show

Show an announcement.

Usage

admidio announcement:show ANNOUNCEMENT [--format=text|json]

Arguments

Argument Required Description
announcement yes Announcement UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

announcement:update

Update an announcement.

Usage

admidio announcement:update ANNOUNCEMENT [options]

Arguments

Argument Required Description
announcement yes Announcement.

Options

Option Description
–headline=TEXT Headline.
–category=CATEGORY Announcement category.
–description=TEXT HTML/text description.
–description-file=FILE Read description from file.

autologin:cleanup

Run native auto-login table cleanup.

Usage

admidio autologin:cleanup

category-report:add

Create a category-report configuration.

Usage

admidio category-report:add --name=NAME --column=COLUMN ... [options]

Required right

The acting user selected with –as must be an Admidio administrator.

Options

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.

category-report:copy

Copy a category-report configuration.

Usage

admidio category-report:copy CONFIG [--name=NAME]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
config yes Report config id/name.

Options

Option Description
–name=NAME Name of the copied configuration.

category-report:delete

Delete a category-report configuration.

Usage

admidio category-report:delete CONFIG [--yes]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
config yes Report config id/name.

Options

Option Description
–yes Confirm deletion.

category-report:list

List category-report configurations.

Usage

admidio category-report:list [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

category-report:run

Run a category-report configuration.

Usage

admidio category-report:run CONFIG [--date=DATE] [--filter=TEXT] [--format=FORMAT]

Arguments

Argument Required Description
config yes Report config id/name.

Options

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.

category-report:show

Show a category-report configuration.

Usage

admidio category-report:show CONFIG [--format=text|json]

Arguments

Argument Required Description
config yes Report config UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

category-report:update

Update a category-report configuration.

Usage

admidio category-report:update CONFIG [options]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
config yes Report config id/name.

Options

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.

category:add

Create a category with native view/edit RolesRights.

Usage

admidio category:add TYPE NAME [options]

Arguments

Argument Required Description
type yes Category type.
name yes Category name.

Options

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.

category:delete

Delete an empty non-system category.

Usage

admidio category:delete CATEGORY [--yes]

Arguments

Argument Required Description
category yes Category.

Options

Option Description
–yes Confirm deletion.

category:list

List categories.

Usage

admidio category:list [--type=ANN|AWA|EVT|FOT|IVT|LNK|ROL|USF] [--format=FORMAT]

Options

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.

category:move

Move a category one position.

Usage

admidio category:move CATEGORY up|down

Arguments

Argument Required Description
category yes Category.
direction yes up or down.

category:show

Show a category.

Usage

admidio category:show CATEGORY [--format=text|json]

Arguments

Argument Required Description
category yes Category UUID/id/name.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

category:update

Update a category and its view/edit rights.

Usage

admidio category:update CATEGORY [--name=NAME] [options]

Arguments

Argument Required Description
category yes Category.

Options

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.

changelog:list

List permitted changelog records.

Usage

admidio changelog:list [--table=TABLE ...] [--object=UUID] [--user=USER] [--date-from=DATE] [--date-to=DATE] [--action=ACTION] [--format=FORMAT]

Options

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.

changelog:show

Show one permitted changelog record.

Usage

admidio changelog:show CHANGE [--format=text|json]

Arguments

Argument Required Description
change yes Log change id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

cli:selfcheck

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.

Usage

admidio cli:selfcheck [--format=table|json|csv|md|dokuwiki]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

Examples

admidio cli:selfcheck --format=json

completion

Print a shell completion script for the Admidio command line.

Usage

admidio completion [bash|zsh]

Arguments

Argument Required Description
shell no Shell to generate the script for. Defaults to bash.

Examples

admidio completion bash > /etc/bash_completion.d/admidio
admidio completion zsh > "${fpath[1]}/_admidio"

config:delete

Delete an organization preference.

Usage

admidio config:delete NAME [--yes]

Arguments

Argument Required Description
name yes Preference name.

Options

Option Description
–yes Confirm deletion.

config:get

Read a preference.

Usage

admidio config:get NAME [--type=raw|string|int|float|bool] [--format=text|json]

Arguments

Argument Required Description
name yes Preference name.

Options

Option Description
–type=TYPE Typed SettingsManager getter. Possible values: raw, string, int, float, bool.
–format=FORMAT Output format. Possible values: text, record, json.

config:list

List organization preferences.

Usage

admidio config:list [--filter=PATTERN] [--format=table|json|csv|md|dokuwiki]

Options

Option Description
–filter=PATTERN Only include preference names containing this text.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

config:set

Store a preference through SettingsManager.

Usage

admidio config:set NAME VALUE

Arguments

Argument Required Description
name yes Preference name.
value yes Preference value.

database:backup

Create a native Admidio database dump.

Usage

admidio database:backup [--output=FILE]

document:download

Download a managed document.

Usage

admidio document:download FILE [--output=FILEPATH]

Arguments

Argument Required Description
file yes File UUID.

document:file-delete

Delete a managed file.

Usage

admidio document:file-delete FILE [--yes]

Arguments

Argument Required Description
file yes File UUID.

Options

Option Description
–yes Confirm deletion.

document:file-move

Move a managed file.

Usage

admidio document:file-move FILE DESTINATION_FOLDER

Arguments

Argument Required Description
file yes File UUID.
destination-folder yes Destination folder UUID.

document:file-rename

Rename a managed file.

Usage

admidio document:file-rename FILE NAME

Arguments

Argument Required Description
file yes File UUID.
name yes New filename.

document:folder-add

Create a managed folder.

Usage

admidio document:folder-add PARENT_FOLDER NAME

Arguments

Argument Required Description
parent-folder yes Parent folder UUID; use root UUID for root.
name yes Folder name.

document:folder-delete

Delete a managed folder recursively where native rights permit.

Usage

admidio document:folder-delete FOLDER [--yes]

Arguments

Argument Required Description
folder yes Folder UUID.

Options

Option Description
–yes Confirm recursive deletion.

document:folder-move

Move a managed folder.

Usage

admidio document:folder-move FOLDER DESTINATION_FOLDER

Arguments

Argument Required Description
folder yes Folder UUID.
destination-folder yes Destination folder UUID.

document:folder-rename

Rename a managed folder.

Usage

admidio document:folder-rename FOLDER NAME

Arguments

Argument Required Description
folder yes Folder UUID.
name yes New folder name.

document:list

List folders/files visible below a folder.

Usage

admidio document:list [FOLDER] [--recursive] [--format=FORMAT]

Arguments

Argument Required Description
folder no Folder UUID; empty means root.

Options

Option Description
–recursive Traverse recursively.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

document:permissions

Show folder view/upload role assignments.

Usage

admidio document:permissions FOLDER [--format=text|json]

Arguments

Argument Required Description
folder yes Folder UUID.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

document:permissions-set

Set folder view/upload role assignments.

Usage

admidio document:permissions-set FOLDER [--view-role=GROUP ...] [--upload-role=GROUP ...] [--public=BOOL] [--recursive=BOOL]

Arguments

Argument Required Description
folder yes Folder UUID.

Options

Option Description
–view-role=GROUP … View role.
–upload-role=GROUP … Upload role.
–public=BOOL Folder public flag.
–recursive=BOOL Apply rights recursively.

document:register

Register physical child entries missing from the database.

Usage

admidio document:register FOLDER [--recursive]

Arguments

Argument Required Description
folder yes Folder UUID.

Options

Option Description
–recursive Register recursively.

document:unregistered

Find physical folders/files not registered in the database.

Usage

admidio document:unregistered [FOLDER] [--format=FORMAT]

Arguments

Argument Required Description
folder no Folder UUID; root if omitted.

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

document:upload

Upload a managed document.

Usage

admidio document:upload FILEPATH --folder=FOLDER [--name=NAME]

Arguments

Argument Required Description
filepath yes Local file path.

Options

Option Description
–folder=FOLDER Destination folder.
–name=NAME Stored filename.

email:test

Send the configured Admidio test email to the acting administrator.

Usage

admidio email:test

forum:export-rss

Generate the forum RSS feed.

Usage

admidio forum:export-rss [--category=CATEGORY] [--output=FILE]

Options

Option Description
–category=CATEGORY Forum category.

forum:list

List forum topics.

Usage

admidio forum:list [--category=CATEGORY] [--format=FORMAT]

Options

Option Description
–category=CATEGORY Forum category.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

forum:post-add

Add a post to a topic.

Usage

admidio forum:post-add TOPIC (--text=TEXT|--text-file=FILE)

Arguments

Argument Required Description
topic yes Topic.

Options

Option Description
–text=TEXT Post text.
–text-file=FILE Read post from file.

forum:post-delete

Delete a forum post.

Usage

admidio forum:post-delete POST [--yes]

Arguments

Argument Required Description
post yes Post.

Options

Option Description
–yes Confirm deletion.

forum:post-update

Update a forum post.

Usage

admidio forum:post-update POST (--text=TEXT|--text-file=FILE)

Arguments

Argument Required Description
post yes Post UUID/id.

Options

Option Description
–text=TEXT Post text.
–text-file=FILE Read post from file.

forum:topic

Show a forum topic and its posts.

Usage

admidio forum:topic TOPIC [--format=text|json]

Arguments

Argument Required Description
topic yes Topic UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

forum:topic-add

Create a forum topic with its first post.

Usage

admidio forum:topic-add --category=CATEGORY --title=TEXT (--text=TEXT|--text-file=FILE)

Options

Option Description
–category=CATEGORY Forum category.
–title=TEXT Topic title.
–text=TEXT First post text.
–text-file=FILE Read first post from file.

forum:topic-delete

Delete a forum topic and its posts.

Usage

admidio forum:topic-delete TOPIC [--yes]

Arguments

Argument Required Description
topic yes Topic.

Options

Option Description
–yes Confirm deletion.

forum:topic-update

Update a forum topic.

Usage

admidio forum:topic-update TOPIC [--category=CATEGORY] [--title=TEXT]

Arguments

Argument Required Description
topic yes Topic.

Options

Option Description
–category=CATEGORY Forum category.
–title=TEXT Topic title.

group:activate

Activate a role/group.

Usage

admidio group:activate GROUP

Arguments

Argument Required Description
group yes Group.

group:add

Create a role/group.

Usage

admidio group:add NAME --category=CATEGORY [options]

Arguments

Argument Required Description
name yes Role name.

Options

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.

group:adddependency

Add a dependent child role.

Usage

admidio group:adddependency GROUP DEPENDENT_GROUP

Arguments

Argument Required Description
group yes Parent group.
dependent-group yes Dependent child group.

group:adduser

Assign a user to a group.

Usage

admidio group:adduser GROUP USER [--start=DATE] [--end=DATE] [--leader=BOOL] [--force-period]

Arguments

Argument Required Description
group yes Group.
user yes User.

Options

Option Description
–start=DATE Membership start date.
–end=DATE Membership end date.
–leader=BOOL Leader status.
–force-period Pass forcePeriod=true to Role::setMembership().

group:deactivate

Deactivate a role/group.

Usage

admidio group:deactivate GROUP

Arguments

Argument Required Description
group yes Group.

group:deldependency

Remove a role dependency.

Usage

admidio group:deldependency GROUP DEPENDENT_GROUP [--yes]

Arguments

Argument Required Description
group yes Parent group.
dependent-group yes Dependent child group.

Options

Option Description
–yes Confirm removal.

group:delete

Delete a role/group.

Usage

admidio group:delete GROUP [--yes]

Arguments

Argument Required Description
group yes Group.

Options

Option Description
–yes Confirm deletion.

group:deletemembership

Permanently delete one membership history row.

Usage

admidio group:deletemembership MEMBERSHIP [--yes]

Arguments

Argument Required Description
membership yes Membership UUID/id.

Options

Option Description
–yes Confirm permanent history deletion.

group:deluser

End a current group membership using Role::stopMembership().

Usage

admidio group:deluser GROUP USER [--date=DATE]

Arguments

Argument Required Description
group yes Group.
user yes User.

Options

Option Description
–date=DATE Last day of the membership. Without this option the membership is ended as of today.

group:dependencies

List parent/child role dependencies.

Usage

admidio group:dependencies GROUP [--format=FORMAT]

Arguments

Argument Required Description
group yes Group.

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

group:export

Export group members as vCards.

Usage

admidio group:export GROUP [--output=FILE]

Arguments

Argument Required Description
group yes Group.

group:list

List groups/roles.

Usage

admidio group:list [--category=CATEGORY] [--active=BOOL] [--format=FORMAT]

Options

Option Description
–category=CATEGORY Role category.
–active=BOOL Filter rol_valid.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

group:members

List role memberships.

Usage

admidio group:members GROUP [--date=DATE] [--active] [--former] [--future] [--leaders] [--format=FORMAT]

Arguments

Argument Required Description
group yes Group.

Options

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.

group:permissions

Show or change native role permission columns.

Usage

admidio group:permissions GROUP [--set=RIGHT=BOOL ...] [--format=text|json]

Arguments

Argument Required Description
group yes Group.

Options

Option Description
–set=RIGHT=BOOL … Set a rol_* permission column.
–format=FORMAT Output format. Possible values: text, record, json.

group:show

Show a group/role.

Usage

admidio group:show GROUP [--members] [--permissions] [--format=text|json]

Arguments

Argument Required Description
group yes Group UUID/id/name.

Options

Option Description
–members Include current members.
–permissions Include role permission columns.
–format=FORMAT Output format. Possible values: text, record, json.

group:update

Update a role/group.

Usage

admidio group:update GROUP [options]

Arguments

Argument Required Description
group yes Group.

Options

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.

group:updateuser

Update an existing membership period/leader status.

Usage

admidio group:updateuser GROUP USER [--start=DATE] [--end=DATE] [--leader=BOOL] [--force-period=BOOL]

Arguments

Argument Required Description
group yes Group.
user yes User.

Options

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.

help

Show command help. Markdown and native DokuWiki output can be generated from the registry.

Usage

admidio help [COMMAND] [--all] [--format=text|md|dokuwiki|json] [--output=FILE]

Arguments

Argument Required Description
command no Command whose help should be displayed.

Options

Option Description
–all Render documentation for all registered commands.
–format=FORMAT Help format. Possible values: text, md, dokuwiki, json.

Examples

admidio help group:adduser
admidio help --all --format=md
admidio help --all --format=dokuwiki

htaccess:disable

Remove the Admidio .htaccess protection file.

Usage

admidio htaccess:disable [--yes]

Options

Option Description
–yes Confirm removal of protection.

htaccess:enable

Protect adm_my_files through the native Htaccess helper.

Usage

admidio htaccess:enable

htaccess:status

Show whether adm_my_files is protected by an .htaccess file. Exits with 3 if it is unprotected.

Usage

admidio htaccess:status [--format=text|json]

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

install:check

Check all values and prerequisites of a new installation without changing anything. Missing values are asked for.

Usage

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]

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.

Examples

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:run

Install a new Admidio database with its first organization and administrator. Missing values are asked for, –no-interaction requires all of them as options.

Usage

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]

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.
–yes Confirm the installation.

Examples

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

inventory:add

Create an inventory item.

Usage

admidio inventory:add --field=FIELD=VALUE ...

Options

Option Description
–field=FIELD=VALUE … Inventory field assignment.

inventory:checkout

Assign an inventory item to a receiver.

Usage

admidio inventory:checkout ITEM --user=USER [--date=DATE]

Arguments

Argument Required Description
item yes Item.

Options

Option Description
–user=USER Receiver user.
–date=DATE Borrow date.

inventory:copy

Copy an inventory item.

Usage

admidio inventory:copy ITEM [--copies=N] [--number-field=FIELD] [--field=FIELD=VALUE ...]

Arguments

Argument Required Description
item yes Item.

Options

Option Description
–copies=N Number of copies.
–number-field=FIELD Numeric inventory field to increment for copied items.
–field=FIELD=VALUE … Inventory field assignment.

inventory:delete

Delete inventory items using ItemService::delete().

Usage

admidio inventory:delete ITEM ... [--yes]

Arguments

Argument Required Description
item yes One or more items.

Options

Option Description
–yes Confirm deletion.

inventory:export

Export inventory items.

Usage

admidio inventory:export --format=FORMAT [--output=FILE]

Options

Option Description
–format=FORMAT Export format. Possible values: xlsx, ods, csv-ms, csv-oo, pdf, pdfl.

inventory:field-add

Create an inventory field.

Usage

admidio inventory:field-add --name=NAME --type=TYPE [options]

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.

inventory:field-delete

Delete an inventory field using ItemFieldService::delete().

Usage

admidio inventory:field-delete FIELD [--yes]

Arguments

Argument Required Description
field yes Inventory field.

Options

Option Description
–yes Confirm deletion.

inventory:field-move

Move an inventory field.

Usage

admidio inventory:field-move FIELD up|down

Arguments

Argument Required Description
field yes Inventory field.
direction yes up or down.

inventory:field-show

Show an inventory field definition.

Usage

admidio inventory:field-show FIELD [--format=text|json]

Arguments

Argument Required Description
field yes Inventory field UUID/id/internal name.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

inventory:field-update

Update an inventory field.

Usage

admidio inventory:field-update FIELD [options]

Arguments

Argument Required Description
field yes Inventory field.

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.

inventory:fields

List inventory field definitions.

Usage

admidio inventory:fields [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

inventory:import

Import inventory items from a spreadsheet or delimited file.

Usage

admidio inventory:import FILE [options]

Arguments

Argument Required Description
file yes Import file.

Options

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.

inventory:import-check

Preview an inventory import: report the resolved field mapping and the number of items without writing anything.

Usage

admidio inventory:import-check FILE [options] [--format=text|json]

Arguments

Argument Required Description
file yes Import file.

Options

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.

inventory:list

List inventory items.

Usage

admidio inventory:list [--search=TEXT] [--category=CATEGORY] [--status=active|retired|all] [--format=FORMAT]

Options

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.

inventory:option-add

Add a select option.

Usage

admidio inventory:option-add FIELD VALUE

Arguments

Argument Required Description
field yes Inventory field.
value yes Option value.

inventory:option-delete

Delete a select option if unused.

Usage

admidio inventory:option-delete FIELD OPTION [--yes]

Arguments

Argument Required Description
field yes Inventory field.
option yes Option id.

Options

Option Description
–yes Confirm deletion.

inventory:option-move

Move a select option.

Usage

admidio inventory:option-move FIELD OPTION up|down

Arguments

Argument Required Description
field yes Inventory field.
option yes Option id.
direction yes up or down.

inventory:option-update

Update a select option.

Usage

admidio inventory:option-update FIELD OPTION [--value=VALUE] [--obsolete=BOOL]

Arguments

Argument Required Description
field yes Inventory field.
option yes Option id.

Options

Option Description
–value=VALUE Option value.
–obsolete=BOOL Obsolete flag.

inventory:options

List select options for an inventory field.

Usage

admidio inventory:options FIELD [--include-obsolete] [--format=FORMAT]

Arguments

Argument Required Description
field yes Inventory field.

Options

Option Description
–include-obsolete Include obsolete options.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

inventory:picture-delete

Delete the picture of an inventory item.

Usage

admidio inventory:picture-delete ITEM [--yes]

Arguments

Argument Required Description
item yes Item.

Options

Option Description
–yes Confirm deletion.

inventory:picture-get

Export the picture of an inventory item.

Usage

admidio inventory:picture-get ITEM [--output=FILE]

Arguments

Argument Required Description
item yes Item.

inventory:picture-set

Set the picture of an inventory item.

Usage

admidio inventory:picture-set ITEM FILE

Arguments

Argument Required Description
item yes Item.
file yes JPEG/PNG image file.

inventory:reinstate

Reinstate retired inventory items.

Usage

admidio inventory:reinstate ITEM ...

Arguments

Argument Required Description
item yes One or more items.

inventory:retire

Retire inventory items using ItemService::retireItem().

Usage

admidio inventory:retire ITEM ...

Arguments

Argument Required Description
item yes One or more items.

inventory:return

Return a checked-out inventory item.

Usage

admidio inventory:return ITEM [--date=DATE]

Arguments

Argument Required Description
item yes Item.

Options

Option Description
–date=DATE Return date.

inventory:show

Show an inventory item and its configured field values.

Usage

admidio inventory:show ITEM [--format=text|json]

Arguments

Argument Required Description
item yes Item UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

inventory:update

Update an inventory item.

Usage

admidio inventory:update ITEM [--field=FIELD=VALUE ...]

Arguments

Argument Required Description
item yes Item.

Options

Option Description
–field=FIELD=VALUE … Inventory field assignment.

link:add

Create a web link.

Usage

admidio link:add --name=NAME --url=URL --category=CATEGORY [--description=TEXT]

Options

Option Description
–name=NAME Link name.
–url=URL URL.
–category=CATEGORY Link category.
–description=TEXT Description.

link:delete

Delete a web link.

Usage

admidio link:delete LINK [--yes]

Arguments

Argument Required Description
link yes Link.

Options

Option Description
–yes Confirm deletion.

List web links.

Usage

admidio link:list [--category=CATEGORY] [--format=FORMAT]

Options

Option Description
–category=CATEGORY Link category.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

link:move

Move a web link one position in its category.

Usage

admidio link:move LINK up|down

Arguments

Argument Required Description
link yes Link.
direction yes up or down.

link:show

Show a web link.

Usage

admidio link:show LINK [--format=text|json]

Arguments

Argument Required Description
link yes Link UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

link:update

Update a web link.

Usage

admidio link:update LINK [options]

Arguments

Argument Required Description
link yes Link.

Options

Option Description
–name=NAME Link name.
–url=URL URL.
–category=CATEGORY Link category.
–description=TEXT Description.

list

List registered CLI commands.

Usage

admidio list [NAMESPACE] [--format=table|json|csv|md|dokuwiki]

Arguments

Argument Required Description
namespace no Optional command namespace.

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

list:add

Create a saved member-list configuration.

Usage

admidio list:add NAME [--global=BOOL] --column=COLUMN ... [--condition=...] [--sort=...]

Arguments

Argument Required Description
name yes List name.

Options

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.

list:copy

Copy a saved member-list configuration.

Usage

admidio list:copy LIST --name=NAME [--global=BOOL]

Arguments

Argument Required Description
list yes Source list.

Options

Option Description
–name=NAME Name of the copied list.
–global=BOOL Global/private flag.

list:delete

Delete a saved member-list configuration.

Usage

admidio list:delete LIST [--yes]

Arguments

Argument Required Description
list yes List UUID/id.

Options

Option Description
–yes Confirm deletion.

list:export

Render a saved member list to CSV/XLSX/ODS/PDF.

Usage

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]

Arguments

Argument Required Description
list yes List UUID/id.

Options

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:list

List saved member-list configurations.

Usage

admidio list:list [--global=BOOL] [--format=FORMAT]

Options

Option Description
–global=BOOL Filter global/private lists.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

list:show

Show a saved member-list configuration.

Usage

admidio list:show LIST [--format=text|json]

Arguments

Argument Required Description
list yes List UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

list:update

Update a saved member-list configuration.

Usage

admidio list:update LIST [options]

Arguments

Argument Required Description
list yes List UUID/id.

Options

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.

Usage

admidio maintenance:mode [MODE] [--title=TITLE] [--message=MESSAGE] [--retry-after=SECONDS] [--allow-script=SCRIPT]... [--owner=OWNER] [--force] [--format=record|json]

Arguments

Argument Required Description
mode no Operation to perform: enable, disable or status. Defaults to status.

Options

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.

Examples

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.

Usage

admidio maintenance:repair-categories [--yes]

Options

Option Description
–yes Confirm the repair.

maintenance:repair-documents

Run the native documents/files path repair operation.

Usage

admidio maintenance:repair-documents [--yes]

Options

Option Description
–yes Confirm the repair.

Create a menu entry.

Usage

admidio menu:add NAME [options]

Arguments

Argument Required Description
name yes Menu name.

Options

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 a menu entry.

Usage

admidio menu:delete MENU [--yes]

Arguments

Argument Required Description
menu yes Menu entry.

Options

Option Description
–yes Confirm deletion.

List menu entries.

Usage

admidio menu:list [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

Move a menu entry one position.

Usage

admidio menu:move MENU up|down

Arguments

Argument Required Description
menu yes Menu entry.
direction yes up or down.

Show a menu entry.

Usage

admidio menu:show MENU [--format=text|json]

Arguments

Argument Required Description
menu yes Menu UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

Update a menu entry.

Usage

admidio menu:update MENU [options]

Arguments

Argument Required Description
menu yes Menu entry.

Options

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.

message:delete

Delete message records using Message::delete().

Usage

admidio message:delete MESSAGE ... [--yes]

Arguments

Argument Required Description
message yes One or more messages.

Options

Option Description
–yes Confirm deletion.

message:forward

Forward an email as a new email.

Usage

admidio message:forward MESSAGE (--user=USER|--group=GROUP) [options]

Arguments

Argument Required Description
message yes Source email.

Options

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.

message:get-attachment

Retrieve a message attachment.

Usage

admidio message:get-attachment ATTACHMENT [--output=FILE]

Arguments

Argument Required Description
attachment yes Attachment UUID.

message:list

List messages involving the acting user.

Usage

admidio message:list [--type=email|pm] [--limit=N] [--offset=N] [--format=FORMAT]

Options

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.

message:list-attachments

List attachments of a message.

Usage

admidio message:list-attachments MESSAGE [--format=FORMAT]

Arguments

Argument Required Description
message yes Message.

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

message:reply

Reply to a private-message conversation.

Usage

admidio message:reply MESSAGE (--body=TEXT|--body-file=FILE)

Arguments

Argument Required Description
message yes Private-message conversation.

Options

Option Description
–body=TEXT Message body.
–body-file=FILE Read body from file.

message:send

Send email/private message using the native Message/Email recipient rules.

Usage

admidio message:send --type=email|pm [recipients] --subject=TEXT (--body=TEXT|--body-file=FILE)

Options

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.

message:show

Show a message/conversation entry.

Usage

admidio message:show MESSAGE [--format=text|json]

Arguments

Argument Required Description
message yes Message UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

module:list

List module namespaces represented by registered commands.

Usage

admidio module:list [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

module:tasks

List registered tasks, optionally restricted to one namespace.

Usage

admidio module:tasks [MODULE] [--format=FORMAT]

Arguments

Argument Required Description
module no Optional module namespace.

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

organization:add

Create a suborganization with native basic data and preferences.

Usage

admidio organization:add --short-name=NAME --name=NAME --email=EMAIL [options]

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.

organization:delete

Delete an organization using Organization::delete().

Usage

admidio organization:delete ORG [--yes]

Arguments

Argument Required Description
org yes Organization UUID, id or unique short name.

Options

Option Description
–yes Confirm deletion.

organization:list

List organizations.

Usage

admidio organization:list [--format=table|json|csv|md|dokuwiki]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

organization:show

Show an organization.

Usage

admidio organization:show ORG [--format=text|json]

Arguments

Argument Required Description
org yes Organization UUID, id or unique short name.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

organization:update

Update organization properties.

Usage

admidio organization:update ORG [options]

Arguments

Argument Required Description
org yes Organization UUID, id or unique short name.

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.

permissions:add

Add role assignments for an object right.

Usage

admidio permissions:add RIGHT_TYPE OBJECT_ID --role=GROUP ...

Arguments

Argument Required Description
right-type yes Roles-right name.
object-id yes Numeric object id.

Options

Option Description
–role=GROUP … Role/group.

permissions:clear

Remove all role assignments from an object right.

Usage

admidio permissions:clear RIGHT_TYPE OBJECT_ID [--yes]

Arguments

Argument Required Description
right-type yes Roles-right name.
object-id yes Numeric object id.

Options

Option Description
–yes Confirm removal.

permissions:list

List RolesRights assignments.

Usage

admidio permissions:list [--type=RIGHT_TYPE] [--format=FORMAT]

Options

Option Description
–type=RIGHT_TYPE Roles-right name.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

permissions:remove

Remove role assignments for an object right.

Usage

admidio permissions:remove RIGHT_TYPE OBJECT_ID --role=GROUP ...

Arguments

Argument Required Description
right-type yes Roles-right name.
object-id yes Numeric object id.

Options

Option Description
–role=GROUP … Role/group.

permissions:set

Set role assignments for an object right.

Usage

admidio permissions:set RIGHT_TYPE OBJECT_ID --role=GROUP ...

Arguments

Argument Required Description
right-type yes Roles-right name.
object-id yes Numeric object id.

Options

Option Description
–role=GROUP … Role/group.

permissions:show

Show roles assigned to an object right.

Usage

admidio permissions:show RIGHT_TYPE OBJECT_ID [--format=text|json]

Arguments

Argument Required Description
right-type yes Roles-right name.
object-id yes Numeric object id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

photo:album-add

Create a photo album.

Usage

admidio photo:album-add NAME --begin=DATE [options]

Arguments

Argument Required Description
name yes Album name.

Options

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.

photo:album-delete

Delete a photo album through Album::delete().

Usage

admidio photo:album-delete ALBUM [--yes]

Arguments

Argument Required Description
album yes Album.

Options

Option Description
–yes Confirm deletion.

photo:album-download

Download all photos of an album as ZIP.

Usage

admidio photo:album-download ALBUM [--output=FILE]

Arguments

Argument Required Description
album yes Album.

photo:album-lock

Lock a photo album.

Usage

admidio photo:album-lock ALBUM

Arguments

Argument Required Description
album yes Album.

photo:album-show

Show a photo album.

Usage

admidio photo:album-show ALBUM [--format=text|json]

Arguments

Argument Required Description
album yes Album UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

photo:album-unlock

Unlock a photo album.

Usage

admidio photo:album-unlock ALBUM

Arguments

Argument Required Description
album yes Album.

photo:album-update

Update a photo album.

Usage

admidio photo:album-update ALBUM [options]

Arguments

Argument Required Description
album yes Album.

Options

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.

photo:delete

Delete one or more photos from an album.

Usage

admidio photo:delete ALBUM PHOTO_NUMBER ... [--yes]

Arguments

Argument Required Description
album yes Album.
photo-number yes One or more photo numbers.

Options

Option Description
–yes Confirm deletion.

photo:download

Download a single photo.

Usage

admidio photo:download ALBUM PHOTO_NUMBER [--output=FILE]

Arguments

Argument Required Description
album yes Album.
photo-number yes Photo number.

photo:ecard-send

Send an e-card.

Usage

admidio photo:ecard-send ALBUM PHOTO_NUMBER --template=TEMPLATE (--user=USER|--group=GROUP) (--message=TEXT|--message-file=FILE)

Arguments

Argument Required Description
album yes Album.
photo-number yes Photo number.

Options

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.

Examples

photo:ecard-send ALBUM 1 --template=default.tpl --user=john --message="Best wishes!" --as=admin

photo:ecard-templates

List available e-card templates.

Usage

admidio photo:ecard-templates [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

photo:list

List photo albums.

Usage

admidio photo:list [--parent=ALBUM] [--format=FORMAT]

Options

Option Description
–parent=ALBUM Parent album or ALL for a root album.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

photo:rotate

Rotate a photo by 90 degrees.

Usage

admidio photo:rotate ALBUM PHOTO_NUMBER --direction=left|right

Arguments

Argument Required Description
album yes Album.
photo-number yes Photo number.

Options

Option Description
–direction=DIRECTION Rotation direction. Possible values: left, right.

photo:upload

Upload one or more local image files to an album.

Usage

admidio photo:upload ALBUM FILE ...

Arguments

Argument Required Description
album yes Album.
file yes JPEG/PNG image file.

plugin:install

Install a current-interface plugin.

Usage

admidio plugin:install PLUGIN [--add-menu=BOOL]

Arguments

Argument Required Description
plugin yes Plugin name.

Options

Option Description
–add-menu=BOOL Add plugin menu entry.

plugin:list

List discovered plugins and installation/update state.

Usage

admidio plugin:list [--installed] [--updates] [--format=FORMAT]

Options

Option Description
–installed Only installed plugins.
–updates Only plugins with updates.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

plugin:move

Move plugin ordering.

Usage

admidio plugin:move PLUGIN up|down

Arguments

Argument Required Description
plugin yes Plugin name.
direction yes up or down.

plugin:remove

Uninstall a current-interface plugin.

Usage

admidio plugin:remove PLUGIN [--remove-menu=BOOL] [--yes]

Arguments

Argument Required Description
plugin yes Plugin name.

Options

Option Description
–remove-menu=BOOL Remove plugin menu entry.
–yes Confirm uninstall.

plugin:show

Show plugin metadata/state.

Usage

admidio plugin:show PLUGIN [--format=text|json]

Arguments

Argument Required Description
plugin yes Plugin name.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

plugin:update

Run a plugin update.

Usage

admidio plugin:update PLUGIN

Arguments

Argument Required Description
plugin yes Plugin name.

profile:field-add

Create a profile field.

Usage

admidio profile:field-add --name=NAME --category=CATEGORY --type=TYPE [options]

Required right

The acting user selected with –as must be an Admidio administrator.

Options

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.

profile:field-delete

Delete a profile field through ProfileField::delete().

Usage

admidio profile:field-delete FIELD [--yes]

Arguments

Argument Required Description
field yes Profile field.

Options

Option Description
–yes Confirm deletion.

profile:field-move

Move a profile field.

Usage

admidio profile:field-move FIELD up|down

Arguments

Argument Required Description
field yes Profile field.
direction yes up or down.

profile:field-show

Show a profile field definition.

Usage

admidio profile:field-show FIELD [--format=text|json]

Arguments

Argument Required Description
field yes Profile field UUID/id/internal name.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

profile:field-update

Update a profile field.

Usage

admidio profile:field-update FIELD [options]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
field yes Profile field.

Options

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.

profile:fields

List profile field definitions.

Usage

admidio profile:fields [--category=CATEGORY] [--format=FORMAT]

Options

Option Description
–category=CATEGORY Profile-field category.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

profile:option-add

Add a profile select option.

Usage

admidio profile:option-add FIELD VALUE

Arguments

Argument Required Description
field yes Profile field.
value yes Option value.

profile:option-delete

Delete an unused profile select option.

Usage

admidio profile:option-delete FIELD OPTION [--yes]

Arguments

Argument Required Description
field yes Profile field.
option yes Option id.

Options

Option Description
–yes Confirm deletion.

profile:option-move

Move a profile select option.

Usage

admidio profile:option-move FIELD OPTION up|down

Arguments

Argument Required Description
field yes Profile field.
option yes Option id.
direction yes up or down.

profile:option-update

Update a profile select option.

Usage

admidio profile:option-update FIELD OPTION [--value=VALUE] [--obsolete=BOOL]

Arguments

Argument Required Description
field yes Profile field.
option yes Option id.

Options

Option Description
–value=VALUE Option value.
–obsolete=BOOL Obsolete flag.

profile:options

List select options of a profile field.

Usage

admidio profile:options FIELD [--include-obsolete] [--format=FORMAT]

Arguments

Argument Required Description
field yes Profile field.

Options

Option Description
–include-obsolete Include obsolete options.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

registration:approve

Approve a registration using UserRegistration::acceptRegistration().

Usage

admidio registration:approve USER [--group=GROUP ...]

Arguments

Argument Required Description
user yes Registration user.

Options

Option Description
–group=GROUP … Additional group after approval.

registration:assign

Assign a pending registration to an existing user using RegistrationService.

Usage

admidio registration:assign REGISTRATION_USER EXISTING_USER [--existing-member=BOOL]

Arguments

Argument Required Description
registration-user yes Pending registration user.
existing-user yes Existing user.

Options

Option Description
–existing-member=BOOL Existing user is already a member of the current organization.

registration:confirm

Confirm a registration validation id.

Usage

admidio registration:confirm USER VALIDATION_ID

Arguments

Argument Required Description
user yes Registration user UUID.
validation-id yes Registration validation id.

registration:create-user

Alias for registration:approve.

Usage

admidio registration:create-user USER [--group=GROUP ...]

Alias

This command is another name for registration:approve and behaves identically.

Arguments

Argument Required Description
user yes Registration user.

Options

Option Description
–group=GROUP … Additional group after approval.

registration:delete

Delete a pending registration.

Usage

admidio registration:delete USER [--yes]

Arguments

Argument Required Description
user yes Registration user.

Options

Option Description
–yes Confirm deletion.

registration:list

List pending registrations.

Usage

admidio registration:list [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

registration:send-login

Send login data to the matched existing user.

Usage

admidio registration:send-login REGISTRATION_USER EXISTING_USER

Arguments

Argument Required Description
registration-user yes Pending registration user.
existing-user yes Existing user.

registration:show

Show a pending registration.

Usage

admidio registration:show USER [--format=text|json]

Arguments

Argument Required Description
user yes Registration user UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

registration:similar

Search native similar-user matches for a registration.

Usage

admidio registration:similar USER [--format=FORMAT]

Arguments

Argument Required Description
user yes Registration user.

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, md.

relation-type:add

Create a user relation type.

Usage

admidio relation-type:add --name=NAME --type=TYPE [options]

Required right

The acting user selected with –as must be an Admidio administrator.

Options

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.

relation-type:delete

Delete a user relation type.

Usage

admidio relation-type:delete TYPE [--yes]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
type yes Relation type UUID/id.

Options

Option Description
–yes Confirm deletion.

relation-type:list

List user relation types.

Usage

admidio relation-type:list [--format=FORMAT]

Options

Option Description
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

relation-type:show

Show a user relation type.

Usage

admidio relation-type:show TYPE [--format=text|json]

Arguments

Argument Required Description
type yes Relation type UUID or id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

relation-type:update

Update a user relation type. Its existing relation shape is retained, matching current master.

Usage

admidio relation-type:update TYPE [options]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
type yes Relation type UUID/id.

Options

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.

relation:add

Create a user relation.

Usage

admidio relation:add USER1 USER2 TYPE

Arguments

Argument Required Description
user1 yes First user.
user2 yes Second user.
type yes Relation type UUID/id.

relation:delete

Delete a user relation including its native inverse record.

Usage

admidio relation:delete RELATION [--yes]

Arguments

Argument Required Description
relation yes Relation UUID/id.

Options

Option Description
–yes Confirm deletion.

relation:list

List user relations.

Usage

admidio relation:list [USER] [--type=TYPE] [--format=FORMAT]

Arguments

Argument Required Description
user no Optional user.

Options

Option Description
–type=TYPE Relation type.
–format=FORMAT Output format. Possible values: table, record, json, csv, md, dokuwiki.

session:cleanup

Delete stale PHP-session database records.

Usage

admidio session:cleanup [--max-inactive-minutes=N]

Options

Option Description
–max-inactive-minutes=N Inactive age threshold.

session:invalidate

Mark all active sessions of a user for reload.

Usage

admidio session:invalidate USER

Arguments

Argument Required Description
user yes User.

session:invalidate-all

Mark all active sessions for reload.

Usage

admidio session:invalidate-all [--yes]

Options

Option Description
–yes Confirm invalidation.

sso:certificate-export

Export an SSO certificate.

Usage

admidio sso:certificate-export KEY [--output=FILE]

Arguments

Argument Required Description
key yes Key UUID/id.

sso:disable

Disable an SSO client using SSOClient::enable(false).

Usage

admidio sso:disable CLIENT [--type=saml|oidc]

Arguments

Argument Required Description
client yes Client UUID/client id.

Options

Option Description
–type=TYPE Disambiguate client type. Possible values: saml, oidc.

sso:enable

Enable an SSO client using SSOClient::enable().

Usage

admidio sso:enable CLIENT [--type=saml|oidc]

Arguments

Argument Required Description
client yes Client UUID/client id.

Options

Option Description
–type=TYPE Disambiguate client type. Possible values: saml, oidc.

sso:key-add

Generate and store a new SSO key/certificate.

Usage

admidio sso:key-add --name=NAME --country=CODE --state=TEXT --locality=TEXT --organization-unit=TEXT [options]

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.

sso:key-delete

Delete an SSO key Entity.

Usage

admidio sso:key-delete KEY [--yes]

Arguments

Argument Required Description
key yes Key UUID/id.

Options

Option Description
–yes Confirm deletion.

sso:key-export

Export an SSO key as PKCS#12.

Usage

admidio sso:key-export KEY [--password=PASSWORD|--password-stdin] [--output=FILE]

Arguments

Argument Required Description
key yes Key UUID/id.

Options

Option Description
–password=PASSWORD PKCS#12 export password. Prefer –password-stdin.
–password-stdin Read export password from STDIN.

sso:key-generate

Generate a new key and certificate.

Usage

admidio sso:key-generate --name=NAME --country=CODE --state=TEXT --locality=TEXT --organization-unit=TEXT [options]

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.

sso:key-regenerate

Regenerate an existing key and certificate.

Usage

admidio sso:key-regenerate KEY [options] [--yes]

Arguments

Argument Required Description
key yes Key UUID/id.

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.
–yes Confirm key regeneration.

sso:key-show

Show SSO key metadata without private key material.

Usage

admidio sso:key-show KEY [--format=text|json]

Arguments

Argument Required Description
key yes Key UUID/id.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

sso:key-update

Update SSO key metadata without regenerating the key.

Usage

admidio sso:key-update KEY [--name=NAME] [--active=BOOL]

Arguments

Argument Required Description
key yes Key UUID/id.

Options

Option Description
–name=NAME Key name.
–active=BOOL Active flag.

sso:keys

List SSO signing/encryption keys.

Usage

admidio sso:keys [--active=BOOL] [--format=FORMAT]

Options

Option Description
–active=BOOL Only active keys.
–format=FORMAT Output format. Possible values: table, record, json, md, dokuwiki.

sso:list

List SAML/OIDC clients.

Usage

admidio sso:list [--type=saml|oidc] [--enabled=BOOL] [--format=FORMAT]

Options

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.

sso:oidc-add

Create an OIDC client.

Usage

admidio sso:oidc-add --name=NAME --client-id=ID [options]

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.

sso:oidc-delete

Delete an OIDC client using the native OIDCClient entity.

Usage

admidio sso:oidc-delete CLIENT [--yes]

Arguments

Argument Required Description
client yes OIDC client UUID/client id.

Options

Option Description
–yes Confirm deletion.

sso:oidc-discovery

Render OIDC discovery metadata.

Usage

admidio sso:oidc-discovery [--format=json] [--output=FILE]

Options

Option Description
–format=FORMAT Output format. Possible values: json.

sso:oidc-update

Update an OIDC client.

Usage

admidio sso:oidc-update CLIENT [options]

Arguments

Argument Required Description
client yes OIDC client UUID/client 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.

sso:saml-add

Create a SAML client.

Usage

admidio sso:saml-add --name=NAME --client-id=ID --acs-url=URL [options]

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.

sso:saml-delete

Delete a SAML client using the native SAMLClient entity.

Usage

admidio sso:saml-delete CLIENT [--yes]

Arguments

Argument Required Description
client yes SAML client UUID/client id.

Options

Option Description
–yes Confirm deletion.

sso:saml-metadata

Render SAML IdP metadata.

Usage

admidio sso:saml-metadata [--output=FILE]

sso:saml-update

Update a SAML client.

Usage

admidio sso:saml-update CLIENT [options]

Arguments

Argument Required Description
client yes SAML client UUID/client id.

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.

sso:show

Show an SSO client.

Usage

admidio sso:show CLIENT [--type=saml|oidc] [--format=text|json]

Arguments

Argument Required Description
client yes Client UUID/client id.

Options

Option Description
–type=TYPE Disambiguate client type. Possible values: saml, oidc.
–format=FORMAT Output format. Possible values: text, record, json.

sso:token-cleanup

Delete expired/revoked OIDC token/code rows.

Usage

admidio sso:token-cleanup [--yes]

Options

Option Description
–yes Confirm cleanup.

status

Show installation, organization and filesystem/database update status. Exits with 3 if the status is not ok.

Usage

admidio status [--format=text|json]

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

system:info

Show Admidio, PHP, database and operating-system information.

Usage

admidio system:info [--format=text|json]

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

system:phpinfo

Print PHP configuration information in text form.

Usage

admidio system:phpinfo

update:check

Check the public Admidio release information used by the preferences update check. Exits with 4 if an update is available.

Usage

admidio update:check [--format=text|json]

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

user:add

Create a user using native profile fields and default-role assignment.

Usage

admidio user:add --field=FIELD=VALUE ... [--login=LOGIN] [--password-stdin] [--group=GROUP ...]

Options

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.

user:copy

Create a new user initialized from another profile.

Usage

admidio user:copy USER [--login=LOGIN] [--field=FIELD=VALUE ...] [--group=GROUP ...]

Arguments

Argument Required Description
user yes Source user.

Options

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.

user:delete

Permanently delete users where the native organization checks allow it.

Usage

admidio user:delete USER ... [--any-organization] [--yes]

Required right

The acting user selected with –as must be an Admidio administrator.

Arguments

Argument Required Description
user yes One or more users.

Options

Option Description
–any-organization Also resolve users that are not members of the current organization.
–yes Confirm permanent deletion.

user:export

Export a user as the native vCard representation.

Usage

admidio user:export USER [--output=FILE]

Arguments

Argument Required Description
user yes User to export.

user:import

Import contacts from a supported spreadsheet/text file.

Usage

admidio user:import FILE [options]

Availability

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.

Arguments

Argument Required Description
file yes Import file.

user:import-check

Validate and preview a contacts import.

Usage

admidio user:import-check FILE [options]

Availability

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.

Arguments

Argument Required Description
file yes Import file.

user:list

List users in the current organization.

Usage

admidio user:list [--search=TEXT] [--group=GROUP] [--former] [--limit=N] [--offset=N] [--format=FORMAT]

Options

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.

user:photo-delete

Delete the user profile photo.

Usage

admidio user:photo-delete USER [--yes]

Arguments

Argument Required Description
user yes User.

Options

Option Description
–yes Confirm deletion.

user:photo-set

Set the user profile photo.

Usage

admidio user:photo-set USER FILE

Arguments

Argument Required Description
user yes User.
file yes JPEG/PNG image file.

user:remove

End current-organization memberships so the user becomes a former member.

Usage

admidio user:remove USER ... [--yes]

Arguments

Argument Required Description
user yes One or more users.

Options

Option Description
–yes Confirm removal.

user:send-login

Alias for user:send-password.

Usage

admidio user:send-login USER

Alias

This command is another name for user:send-password and behaves identically.

Arguments

Argument Required Description
user yes User.

user:send-password

Send the native password-reset/new-password email.

Usage

admidio user:send-password USER

Arguments

Argument Required Description
user yes User.

user:set-password

Set a user password.

Usage

admidio user:set-password USER [--password=PASSWORD|--password-stdin]

Arguments

Argument Required Description
user yes User.

Options

Option Description
–password=PASSWORD New password. Prefer –password-stdin.
–password-stdin Read password from STDIN.

user:show

Show user profile data.

Usage

admidio user:show USER [--memberships] [--relations] [--format=text|json]

Arguments

Argument Required Description
user yes User UUID, id or unique login name.

Options

Option Description
–memberships Include role memberships.
–relations Include user relations.
–format=FORMAT Output format. Possible values: text, record, json.

user:tfa-reset

Remove the configured two-factor secret.

Usage

admidio user:tfa-reset USER [--yes]

Arguments

Argument Required Description
user yes User.

Options

Option Description
–yes Confirm reset.

user:tfa-setup

Set up two-factor authentication for the acting user.

Usage

admidio user:tfa-setup USER [--secret=SECRET|--secret-stdin] [--code=CODE]

Arguments

Argument Required Description
user yes User.

Options

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.

user:tfa-status

Show whether two-factor authentication is configured.

Usage

admidio user:tfa-status USER [--format=text|json]

Arguments

Argument Required Description
user yes User.

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.

user:update

Update login/profile data of a user.

Usage

admidio user:update USER [--login=LOGIN] [--field=FIELD=VALUE ...]

Arguments

Argument Required Description
user yes User UUID, id or login name.

Options

Option Description
–login=LOGIN Login name.
–field=FIELD=VALUE … Profile field assignment INTERNAL_NAME=value.

version

Show filesystem and installed database core version.

Usage

admidio version [--format=text|json]

Options

Option Description
–format=FORMAT Output format. Possible values: text, record, json.