NextCloud v. 30 OCC Command
CSS
NextCloud 30.0.2
Usage:
command [options] [arguments]
Options:
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
-n, --no-interaction Do not ask any interactive question
--no-warnings Skip global warnings, show command output only
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Available commands:
check check dependencies of the server environment
completion Dump the shell completion script
help Display help for a command
list List commands
setupchecks Run setup checks and output the results
status show some status information
upgrade run upgrade routines after installation of a new release. The release has to be installed before.
activity
activity:send-mails Sends the activity notification mails
admin-delegation
admin-delegation:add add setting delegation to a group
admin-delegation:remove remove settings delegation from a group
admin-delegation:show show delegated settings
app
app:disable disable an app
app:enable enable an app
app:getpath Get an absolute path to the app directory
app:install install an app
app:list List all available apps
app:remove remove an app
app:update update an app or all apps
app_api
app_api:app:config:delete Delete ExApp configs
app_api:app:config:get Get ExApp config
app_api:app:config:list List ExApp configs
app_api:app:config:set Set ExApp config
app_api:app:deploy Deploy ExApp on configured daemon
app_api:app:disable Disable registered external app
app_api:app:enable Enable registered external app
app_api:app:list List ExApps
app_api:app:register Install external App
app_api:app:unregister Unregister external app
app_api:app:update Update ExApp
app_api:daemon:list List registered daemons
app_api:daemon:register Register daemon config for ExApp deployment
app_api:daemon:unregister Unregister daemon
background
background:cron [background:ajax|background:webcron] Use cron, ajax or webcron to run background jobs
background-job
background-job:delete Remove a background job from database
background-job:execute Execute a single background job manually
background-job:list List background jobs
background-job:worker Run a background job worker
broadcast
broadcast:test test the SSE broadcaster
circles
circles:check Checking your configuration
circles:maintenance Clean stuff, keeps the app running
circles:manage:config edit config/type of a Circle
circles:manage:create create a new circle
circles:manage:destroy destroy a circle by its ID
circles:manage:details get details about a circle by its ID
circles:manage:edit edit displayName or description of a Circle
circles:manage:join emulate a user joining a Circle
circles:manage:leave simulate a user joining a Circle
circles:manage:list listing current circles
circles:manage:setting edit setting for a Circle
circles:members:add Add a member to a Circle
circles:members:details get details about a member by its ID
circles:members:level Change the level of a member from a Circle
circles:members:list listing Members from a Circle
circles:members:remove remove a member from a circle
circles:members:search Change the level of a member from a Circle
circles:memberships index and display memberships for local and federated users
circles:migrate:customgroups
circles:remote remote features
circles:shares:files listing shares files
circles:sync Sync Circles and Members
circles:test testing some features
config
config:app:delete Delete an app config value
config:app:get Get an app config value
config:app:set Set an app config value
config:import Import a list of configs
config:list List all configs
config:system:delete Delete a system config value
config:system:get Get a system config value
config:system:set Set a system config value
dav
dav:create-addressbook Create a dav addressbook
dav:create-calendar Create a dav calendar
dav:delete-calendar Delete a dav calendar
dav:fix-missing-caldav-changes Insert missing calendarchanges rows for existing events
dav:list-calendars List all calendars of a user
dav:move-calendar Move a calendar from an user to another
dav:remove-invalid-shares Remove invalid dav shares
dav:retention:clean-up
dav:send-event-reminders Sends event reminders
dav:sync-birthday-calendar Synchronizes the birthday calendar
dav:sync-system-addressbook Synchronizes users to the system addressbook
db
db:add-missing-columns Add missing optional columns to the database tables
db:add-missing-indices Add missing indices to the database tables
db:add-missing-primary-keys Add missing primary keys to the database tables
db:convert-filecache-bigint Convert the ID columns of the filecache to BigInt
db:convert-mysql-charset Convert charset of MySQL/MariaDB to use utf8mb4
db:convert-type Convert the Nextcloud database to the newly configured one
db:schema:expected Export the expected database schema for a fresh installation
db:schema:export Export the current database schema
encryption
encryption:change-key-storage-root Change key storage root
encryption:decrypt-all Disable server-side encryption and decrypt all files
encryption:disable Disable encryption
encryption:disable-master-key Disable the master key and use per-user keys instead. Only available for fresh installations with no existing encrypted data! There is no way to enable it again.
encryption:drop-legacy-filekey Scan the files for the legacy filekey format using RC4 and get rid of it (if master key is enabled)
encryption:enable Enable encryption
encryption:enable-master-key Enable the master key. Only available for fresh installations with no existing encrypted data! There is also no way to disable it again.
encryption:encrypt-all Encrypt all files for all users
encryption:fix-encrypted-version Fix the encrypted version if the encrypted file(s) are not downloadable.
encryption:fix-key-location Fix the location of encryption keys for external storage
encryption:list-modules List all available encryption modules
encryption:migrate-key-storage-format Migrate the format of the keystorage to a newer format
encryption:recover-user Recover user data in case of password lost. This only works if the user enabled the recovery key.
encryption:scan:legacy-format Scan the files for the legacy format
encryption:set-default-module Set the encryption default module
encryption:show-key-storage-root Show current key storage root
encryption:status Lists the current status of encryption
federation
federation:sync-addressbooks Synchronizes addressbooks of all federated clouds
files
files:cleanup cleanup filecache
files:copy Copy a file or folder
files:delete Delete a file or folder
files:get Get the contents of a file
files:lock lock a file to a user
files:move Move a file or folder
files:object:delete Delete an object from the object store
files:object:get Get the contents of an object
files:object:put Write a file to the object store
files:put Write contents of a file
files:recommendations:recommend
files:reminders List file reminders
files:repair-tree Try and repair malformed filesystem tree structures
files:scan rescan filesystem
files:scan-app-data rescan the AppData folder
files:transfer-ownership All files and folders are moved to another user - outgoing shares and incoming user file shares (optionally) are moved as well.
files_external
files_external:applicable Manage applicable users and groups for a mount
files_external:backends Show available authentication and storage backends
files_external:config Manage backend configuration for a mount
files_external:create Create a new mount configuration
files_external:delete Delete an external mount
files_external:export Export mount configurations
files_external:import Import mount configurations
files_external:list List configured admin or personal mounts
files_external:notify Listen for active update notifications for a configured external mount
files_external:option Manage mount options for a mount
files_external:scan Scan an external storage for changed files
files_external:verify Verify mount configuration
group
group:add Add a group
group:adduser add a user to a group
group:delete Remove a group
group:info Show information about a group
group:list list configured groups
group:removeuser remove a user from a group
info
info:file get information for a file
info:file:space Summarize space usage of specified folder
integrity
integrity:check-app Check integrity of an app using a signature.
integrity:check-core Check integrity of core code using a signature.
integrity:sign-app Signs an app using a private key.
integrity:sign-core Sign core using a private key.
l10n
l10n:createjs Create javascript translation files for a given app
log
log:file manipulate logging backend
log:manage manage logging configuration
log:tail Tail the nextcloud logfile
log:watch Watch the nextcloud logfile
mail
mail:account:create creates IMAP account
mail:account:delete Delete an IMAP account
mail:account:diagnose Diagnose a user's IMAP connection
mail:account:export Exports a user's IMAP account(s)
mail:account:export-threads Exports a user's account threads
mail:account:sync Synchronize an IMAP account
mail:account:train Train the classifier of new messages
mail:account:update Update a user's IMAP account
mail:clean-up clean up all orphaned data
mail:repair:system-autoresponders Update sieve scripts of all accounts that follow the system out-of-office period
mail:repair:tags Create default tags for account. If no account ID given, all tag entries will be repaired
mail:tags:migration-jobs Creates a background job entry in the cron table for every user to migrate important labels to IMAP
mail:thread Build threads from the exported data of an account
maintenance
maintenance:data-fingerprint update the systems data-fingerprint after a backup is restored
maintenance:mimetype:update-db Update database mimetypes and update filecache
maintenance:mimetype:update-js Update mimetypelist.js
maintenance:mode set maintenance mode
maintenance:repair repair this installation
maintenance:repair-share-owner repair invalid share-owner entries in the database
maintenance:theme:update Apply custom theme changes
maintenance:update:htaccess Updates the .htaccess file
metadata
metadata:get get stored metadata about a file, by its id
migrations
migrations:preview Get preview of available DB migrations in case of initiating an upgrade
notification
notification:delete Delete a generated admin notification for the given user
notification:generate Generate a notification for the given user
notification:test-push Generate a notification for the given user
photos
photos:albums:add Add specified photo to album
photos:albums:create Create a new album for a user
photos:update-1000-cities Update the list of 1000 and more inhabitant cities
preview
preview:generate generate a preview for a file
preview:repair distributes the existing previews into subfolders
preview:reset-rendered-texts Deletes all generated avatars and previews of text and md files
security
security:bruteforce:attempts Show bruteforce attempts status for a given IP address
security:bruteforce:reset resets bruteforce attempts for given IP address
security:certificates list trusted certificates
security:certificates:export export the certificate bundle
security:certificates:import import trusted certificate in PEM format
security:certificates:remove remove trusted certificate
serverinfo
serverinfo:update-storage-statistics Triggers an update of the counts related to storages used in serverinfo
sharing
sharing:cleanup-remote-storages Cleanup shared storage entries that have no matching entry in the shares_external table
sharing:delete-orphan-shares Delete shares where the owner no longer has access to the file
sharing:expiration-notification Notify share initiators when a share will expire the next day.
support
support:report Generate a system report
suspiciouslogin
suspiciouslogin:etl
suspiciouslogin:optimize
suspiciouslogin:predict
suspiciouslogin:seed Fills the database with random IPs for development and testing purposes
suspiciouslogin:train
tag
tag:add Add new tag
tag:delete delete a tag
tag:edit edit tag attributes
tag:list list tags
taskprocessing
taskprocessing:task:list list tasks
taskprocessing:task:stats get statistics for tasks
text
text:reset Reset a text document session to the current file content
theming
theming:config Set theming app config values
trashbin
trashbin:cleanup Remove deleted files
trashbin:expire Expires the users trashbin
trashbin:restore Restore all deleted files according to the given filters
trashbin:size Configure the target trashbin size
twofactor_totp
twofactor_totp:cleanup Remove orphaned totp secrets
twofactor_webauthn
twofactor_webauthn:cleanup Remove orphaned webauthn credentials
twofactor_webauthn:migrate-u2f
twofactorauth
twofactorauth:cleanup Clean up the two-factor user-provider association of an uninstalled/removed provider
twofactorauth:disable Disable two-factor authentication for a user
twofactorauth:enable Enable two-factor authentication for a user
twofactorauth:enforce Enabled/disable enforced two-factor authentication
twofactorauth:state Get the two-factor authentication (2FA) state of a user
update
update:check Check for server and app updates
user
user:add adds an account
user:auth-tokens:add [user:add-app-password] Add app password for the named account
user:auth-tokens:delete Deletes an authentication token
user:auth-tokens:list List authentication tokens of an user
user:clear-avatar-cache clear avatar cache
user:delete deletes the specified user
user:disable disables the specified user
user:enable enables the specified user
user:info show user info
user:keys:verify Verify if the stored public key matches the stored private key
user:lastseen shows when the user was logged in last time
user:list list configured users
user:report shows how many users have access
user:resetpassword Resets the password of the named user
user:setting Read and modify user settings
user:sync-account-data sync user backend data to accounts table for configured users
versions
versions:cleanup Delete versions
versions:expire Expires the users file versions
webhook_listeners
webhook_listeners:list Lists configured webhook listeners
workflows
workflows:list Lists configured workflows