Command line interface¶
A command line interface (CLI) is available to manage database, OAuth2 tokens and users.
$ ftcli
Usage: ftcli [OPTIONS] COMMAND [ARGS]...
FitTrackee Command Line Interface
Options:
--help Show this message and exit.
Commands:
db Manage database.
oauth2 Manage OAuth2 tokens.
users Manage users.
Database¶
ftcli db drop
¶
Added in version 0.6.5.
Empty database and delete uploaded files, only on development environments.
ftcli db upgrade
¶
Added in version 0.6.5.
Apply migrations.
OAuth2¶
ftcli oauth2 clean
¶
Added in version 0.7.0.
Remove tokens expired for more than provided number of days
Options |
Description |
---|---|
|
Number of days. |
Users¶
ftcli users clean_archives
¶
Added in version 0.7.13.
Delete export requests and related archives created more than provided number of days.
Options |
Description |
---|---|
|
Number of days. |
ftcli users clean_tokens
¶
Added in version 0.7.0.
Remove blacklisted tokens expired for more than provided number of days.
Options |
Description |
---|---|
|
Number of days. |
ftcli users create
¶
Added in version 0.7.15.
Changed in version 0.8.4: User preference for interface language is added.
Changed in version 0.9.0: Add option for user role.
Create a user account.
Note
the newly created account is already active.
the CLI allows to create users when registration is disabled.
Arguments/options |
Description |
---|---|
|
Username. |
|
User email (mandatory). |
|
User password (if not provided, a random password is generated). |
|
User preference for interface language (two-letter code, ISO 639-1). If not provided or not supported, it falls back to English (‘en’). |
|
User role (default: ‘user’). |
ftcli users export_archives
¶
Added in version 0.7.13.
Process incomplete user export requests. Can be used if redis is not set (no dramatiq workers running).
Options |
Description |
---|---|
|
Maximum number of export requests to process. |
ftcli users update
¶
Added in version 0.6.5.
Changed in version 0.9.0: Add --set-role
option. --set-admin
is now deprecated.
Modify a user account (role, active status, email and password).
Arguments/options |
Description |
---|---|
|
Username. |
|
[DEPRECATED] Add/remove admin rights (when adding admin rights, it also activates user account if not active). |
|
Set user role (when setting ‘moderator’, ‘admin’ and ‘owner’ role, it also activates user account if not active). |
|
Activate user account. |
|
Reset user password (a new password will be displayed). |
|
Update user email. |