2023-06-18 15:02:21 +02:00
<!doctype html>
2023-08-23 11:36:28 +02:00
< html class = "no-js" lang = "en" data-content_root = "" >
2023-06-18 15:02:21 +02:00
< head > < meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width,initial-scale=1" / >
< meta name = "color-scheme" content = "light dark" > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< link rel = "index" title = "Index" href = "genindex.html" / > < link rel = "search" title = "Search" href = "search.html" / > < link rel = "next" title = "Third-party tools" href = "third_party_tools.html" / > < link rel = "prev" title = "Installation" href = "installation.html" / >
2022-04-24 13:17:38 +02:00
2024-02-04 17:12:04 +01:00
<!-- Generated with Sphinx 7.1.2 and Furo 2024.01.29 -->
< title > Command line interface - FitTrackee 0.7.30 documentation< / title >
2023-08-23 11:36:28 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css?v=fa44fd50" / >
2023-07-30 17:05:25 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/styles/furo.css?v=135e06be" / >
< link rel = "stylesheet" type = "text/css" href = "_static/copybutton.css?v=76b2166b" / >
< link rel = "stylesheet" type = "text/css" href = "_static/styles/furo-extensions.css?v=36a5483c" / >
< link rel = "stylesheet" type = "text/css" href = "_static/css/fork-awesome.min.css?v=876feb3b" / >
< link rel = "stylesheet" type = "text/css" href = "_static/css/custom.css?v=9f1a53bb" / >
2023-06-18 15:02:21 +02:00
< style >
body {
--color-code-background: #eeffcc;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #272822;
--color-code-foreground: #f8f8f2;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #272822;
--color-code-foreground: #f8f8f2;
}
}
}
< / style > < / head >
< body >
< script >
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
< / script >
< svg xmlns = "http://www.w3.org/2000/svg" style = "display: none;" >
< symbol id = "svg-toc" viewBox = "0 0 24 24" >
< title > Contents< / title >
< svg stroke = "currentColor" fill = "currentColor" stroke-width = "0" viewBox = "0 0 1024 1024" >
< path d = "M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z" / >
< / svg >
< / symbol >
< symbol id = "svg-menu" viewBox = "0 0 24 24" >
< title > Menu< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
< line x1 = "3" y1 = "12" x2 = "21" y2 = "12" > < / line >
< line x1 = "3" y1 = "6" x2 = "21" y2 = "6" > < / line >
< line x1 = "3" y1 = "18" x2 = "21" y2 = "18" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-arrow-right" viewBox = "0 0 24 24" >
< title > Expand< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
< polyline points = "9 18 15 12 9 6" > < / polyline >
< / svg >
< / symbol >
< symbol id = "svg-sun" viewBox = "0 0 24 24" >
< title > Light mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
< circle cx = "12" cy = "12" r = "5" > < / circle >
< line x1 = "12" y1 = "1" x2 = "12" y2 = "3" > < / line >
< line x1 = "12" y1 = "21" x2 = "12" y2 = "23" > < / line >
< line x1 = "4.22" y1 = "4.22" x2 = "5.64" y2 = "5.64" > < / line >
< line x1 = "18.36" y1 = "18.36" x2 = "19.78" y2 = "19.78" > < / line >
< line x1 = "1" y1 = "12" x2 = "3" y2 = "12" > < / line >
< line x1 = "21" y1 = "12" x2 = "23" y2 = "12" > < / line >
< line x1 = "4.22" y1 = "19.78" x2 = "5.64" y2 = "18.36" > < / line >
< line x1 = "18.36" y1 = "5.64" x2 = "19.78" y2 = "4.22" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-moon" viewBox = "0 0 24 24" >
< title > Dark mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< path d = "M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" / >
< / svg >
< / symbol >
< symbol id = "svg-sun-half" viewBox = "0 0 24 24" >
< title > Auto light/dark mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< circle cx = "12" cy = "12" r = "9" / >
< path d = "M13 12h5" / >
< path d = "M13 15h4" / >
< path d = "M13 18h1" / >
< path d = "M13 9h4" / >
< path d = "M13 6h1" / >
< / svg >
< / symbol >
< / svg >
< input type = "checkbox" class = "sidebar-toggle" name = "__navigation" id = "__navigation" >
< input type = "checkbox" class = "sidebar-toggle" name = "__toc" id = "__toc" >
< label class = "overlay sidebar-overlay" for = "__navigation" >
< div class = "visually-hidden" > Hide navigation sidebar< / div >
< / label >
< label class = "overlay toc-overlay" for = "__toc" >
< div class = "visually-hidden" > Hide table of contents sidebar< / div >
< / label >
2022-04-24 13:17:38 +02:00
2023-06-18 15:02:21 +02:00
< div class = "page" >
< header class = "mobile-header" >
< div class = "header-left" >
< label class = "nav-overlay-icon" for = "__navigation" >
< div class = "visually-hidden" > Toggle site navigation sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-menu" > < / use > < / svg > < / i >
< / label >
< / div >
< div class = "header-center" >
2024-02-04 17:12:04 +01:00
< a href = "index.html" > < div class = "brand" > FitTrackee 0.7.30
2023-06-18 15:02:21 +02:00
documentation< / div > < / a >
< / div >
< div class = "header-right" >
< div class = "theme-toggle-container theme-toggle-header" >
< button class = "theme-toggle" >
< div class = "visually-hidden" > Toggle Light / Dark / Auto color theme< / div >
< svg class = "theme-icon-when-auto" > < use href = "#svg-sun-half" > < / use > < / svg >
< svg class = "theme-icon-when-dark" > < use href = "#svg-moon" > < / use > < / svg >
< svg class = "theme-icon-when-light" > < use href = "#svg-sun" > < / use > < / svg >
2022-04-24 13:17:38 +02:00
< / button >
< / div >
2023-06-18 15:02:21 +02:00
< label class = "toc-overlay-icon toc-header-icon" for = "__toc" >
< div class = "visually-hidden" > Toggle table of contents sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
< / div >
< / header >
< aside class = "sidebar-drawer" >
< div class = "sidebar-container" >
< div class = "sidebar-sticky" > < a class = "sidebar-brand" href = "index.html" >
< div class = "sidebar-logo-container" >
< img class = "sidebar-logo" src = "_static/ft-logo.png" alt = "Logo" / >
< / div >
2024-02-04 17:12:04 +01:00
< span class = "sidebar-brand-text" > FitTrackee 0.7.30
2023-06-18 15:02:21 +02:00
documentation< / span >
< / a > < form class = "sidebar-search-container" method = "get" action = "search.html" role = "search" >
< input class = "sidebar-search" placeholder = "Search" name = "q" aria-label = "Search" >
< input type = "hidden" name = "check_keywords" value = "yes" >
< input type = "hidden" name = "area" value = "default" >
< / form >
< div id = "searchbox" > < / div > < div class = "sidebar-scroll" > < div class = "sidebar-tree" >
< ul class = "current" >
2022-04-24 13:17:38 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "features.html" > Features< / a > < / li >
2023-04-12 17:32:08 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "oauth.html" > OAuth 2.0< / a > < / li >
2022-04-24 13:17:38 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "installation.html" > Installation< / a > < / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1 current current-page" > < a class = "current reference internal" href = "#" > Command line interface< / a > < / li >
2023-04-12 17:32:08 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "third_party_tools.html" > Third-party tools< / a > < / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "api/index.html" > API documentation< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-1" name = "toctree-checkbox-1" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-1" > < div class = "visually-hidden" > Toggle navigation of API documentation< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/auth.html" > Authentication and account< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/configuration.html" > Configuration< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/oauth2.html" > OAuth2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/records.html" > Records< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/sports.html" > Sports< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/stats.html" > Statistics< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/users.html" > Users< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "api/workouts.html" > Workouts< / a > < / li >
2022-04-24 13:17:38 +02:00
< / ul >
< / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "troubleshooting/index.html" > Troubleshooting< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-2" name = "toctree-checkbox-2" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-2" > < div class = "visually-hidden" > Toggle navigation of Troubleshooting< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "troubleshooting/administrator.html" > Administrator< / a > < / li >
2022-08-27 16:50:29 +02:00
< / ul >
< / li >
2023-06-18 15:02:21 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "changelog.html" > Change log< / a > < / li >
2022-04-24 13:17:38 +02:00
< / ul >
2023-06-18 15:02:21 +02:00
< / div >
2023-06-18 15:23:33 +02:00
< / div > < div id = "furo-languages" tabindex = "0" >
< span class = "languages-label" >
< i class = "fa fa-language" > < / i >
< / span >
< div class = "languages-list" >
< a href = "../en/cli.html" hreflang = en lang = en >
English
< / a >
< a href = "../fr/cli.html" hreflang = fr lang = fr >
Français
< / a >
< / div >
2023-06-18 15:02:21 +02:00
< / div >
< / div >
2022-04-24 13:17:38 +02:00
2023-06-18 15:02:21 +02:00
< / div >
< / aside >
< div class = "main" >
< div class = "content" >
< div class = "article-container" >
< a href = "#" class = "back-to-top muted-link" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" >
< path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z" > < / path >
< / svg >
< span > Back to top< / span >
< / a >
< div class = "content-icon-container" >
< div class = "theme-toggle-container theme-toggle-content" >
< button class = "theme-toggle" >
< div class = "visually-hidden" > Toggle Light / Dark / Auto color theme< / div >
< svg class = "theme-icon-when-auto" > < use href = "#svg-sun-half" > < / use > < / svg >
< svg class = "theme-icon-when-dark" > < use href = "#svg-moon" > < / use > < / svg >
< svg class = "theme-icon-when-light" > < use href = "#svg-sun" > < / use > < / svg >
< / button >
< / div >
< label class = "toc-overlay-icon toc-content-icon" for = "__toc" >
< div class = "visually-hidden" > Toggle table of contents sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
< / div >
< article role = "main" >
< section id = "command-line-interface" >
< h1 > Command line interface< a class = "headerlink" href = "#command-line-interface" title = "Permalink to this heading" > #< / a > < / h1 >
2022-09-19 18:49:25 +02:00
< p > A command line interface (CLI) is available to manage database, OAuth2 tokens and users.< / p >
2023-02-16 11:18:50 +01:00
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $< span class = "w" > < / span > ftcli
Usage:< span class = "w" > < / span > ftcli< span class = "w" > < / span > < span class = "o" > [< / span > OPTIONS< span class = "o" > ]< / span > < span class = "w" > < / span > COMMAND< span class = "w" > < / span > < span class = "o" > [< / span > ARGS< span class = "o" > ]< / span > ...
2022-04-24 13:17:38 +02:00
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > FitTrackee< span class = "w" > < / span > Command< span class = "w" > < / span > Line< span class = "w" > < / span > Interface
2022-04-24 13:17:38 +02:00
Options:
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > --help< span class = "w" > < / span > Show< span class = "w" > < / span > this< span class = "w" > < / span > message< span class = "w" > < / span > and< span class = "w" > < / span > exit.
2022-04-24 13:17:38 +02:00
Commands:
2023-02-16 11:18:50 +01:00
< span class = "w" > < / span > db< span class = "w" > < / span > Manage< span class = "w" > < / span > database.
< span class = "w" > < / span > oauth2< span class = "w" > < / span > Manage< span class = "w" > < / span > OAuth2< span class = "w" > < / span > tokens.
< span class = "w" > < / span > users< span class = "w" > < / span > Manage< span class = "w" > < / span > users.
2022-04-24 13:17:38 +02:00
< / pre > < / div >
< / div >
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< div class = "line-block" >
< div class = "line" > The following commands are now deprecated and will be removed in a next version:< / div >
< div class = "line" > - < code class = "docutils literal notranslate" > < span class = "pre" > fittrackee_set_admin< / span > < / code > < / div >
< div class = "line" > - < code class = "docutils literal notranslate" > < span class = "pre" > fittrackee_upgrade_db< / span > < / code > < / div >
2022-11-27 12:06:42 +01:00
< div class = "line" > - < code class = "docutils literal notranslate" > < span class = "pre" > fittrackee_worker< / span > < / code > (disabled)< / div >
2022-04-24 13:17:38 +02:00
< / div >
< / div >
< section id = "database" >
2023-06-18 15:02:21 +02:00
< h2 > Database< a class = "headerlink" href = "#database" title = "Permalink to this heading" > #< / a > < / h2 >
2023-03-05 14:26:31 +01:00
< section id = "ftcli-db-drop" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > db< / span > < span class = "pre" > drop< / span > < / code > < a class = "headerlink" href = "#ftcli-db-drop" title = "Permalink to this heading" > #< / a > < / h3 >
2022-04-24 13:17:38 +02:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.6.5.< / span > < / p >
< / div >
2023-03-05 14:26:31 +01:00
< p > Empty database and delete uploaded files, only on development environments.< / p >
2022-04-24 13:17:38 +02:00
< / section >
2023-03-05 14:26:31 +01:00
< section id = "ftcli-db-upgrade" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > db< / span > < span class = "pre" > upgrade< / span > < / code > < a class = "headerlink" href = "#ftcli-db-upgrade" title = "Permalink to this heading" > #< / a > < / h3 >
2022-04-24 13:17:38 +02:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.6.5.< / span > < / p >
< / div >
2023-03-05 14:26:31 +01:00
< p > Apply migrations.< / p >
2022-04-24 13:17:38 +02:00
< / section >
< / section >
2022-08-27 16:50:29 +02:00
< section id = "oauth2" >
2023-06-18 15:02:21 +02:00
< h2 > OAuth2< a class = "headerlink" href = "#oauth2" title = "Permalink to this heading" > #< / a > < / h2 >
2022-08-27 16:50:29 +02:00
< section id = "ftcli-oauth2-clean" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > oauth2< / span > < span class = "pre" > clean< / span > < / code > < a class = "headerlink" href = "#ftcli-oauth2-clean" title = "Permalink to this heading" > #< / a > < / h3 >
2022-08-27 16:50:29 +02:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.7.0.< / span > < / p >
< / div >
< p > Remove tokens expired for more than provided number of days< / p >
2023-06-18 15:02:21 +02:00
< div class = "table-wrapper colwidths-given table-bordered docutils container" >
2022-08-27 16:50:29 +02:00
< table class = "table-bordered docutils align-default" >
< colgroup >
< col style = "width: 33.3%" / >
< col style = "width: 66.7%" / >
< / colgroup >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > Options< / p > < / th >
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --days< / span > < / code > < / p > < / td >
< td > < p > Number of days.< / p > < / td >
< / tr >
< / tbody >
< / table >
2023-06-18 15:02:21 +02:00
< / div >
2022-08-27 16:50:29 +02:00
< / section >
< / section >
2022-04-24 13:17:38 +02:00
< section id = "users" >
2023-06-18 15:02:21 +02:00
< h2 > Users< a class = "headerlink" href = "#users" title = "Permalink to this heading" > #< / a > < / h2 >
2023-03-05 14:26:31 +01:00
< section id = "ftcli-users-clean-archives" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > clean_archives< / span > < / code > < a class = "headerlink" href = "#ftcli-users-clean-archives" title = "Permalink to this heading" > #< / a > < / h3 >
2023-03-05 14:26:31 +01:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.7.13.< / span > < / p >
< / div >
< p > Delete export requests and related archives created more than provided number of days.< / p >
2023-06-18 15:02:21 +02:00
< div class = "table-wrapper colwidths-given table-bordered docutils container" >
2023-03-05 14:26:31 +01:00
< table class = "table-bordered docutils align-default" >
< colgroup >
< col style = "width: 33.3%" / >
< col style = "width: 66.7%" / >
< / colgroup >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > Options< / p > < / th >
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --days< / span > < / code > < / p > < / td >
< td > < p > Number of days.< / p > < / td >
< / tr >
< / tbody >
< / table >
2023-06-18 15:02:21 +02:00
< / div >
2023-03-05 14:26:31 +01:00
< / section >
2022-09-15 16:11:13 +02:00
< section id = "ftcli-users-clean-tokens" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > clean_tokens< / span > < / code > < a class = "headerlink" href = "#ftcli-users-clean-tokens" title = "Permalink to this heading" > #< / a > < / h3 >
2022-09-15 16:11:13 +02:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.7.0.< / span > < / p >
< / div >
< p > Remove blacklisted tokens expired for more than provided number of days.< / p >
2023-06-18 15:02:21 +02:00
< div class = "table-wrapper colwidths-given table-bordered docutils container" >
2022-09-15 16:11:13 +02:00
< table class = "table-bordered docutils align-default" >
< colgroup >
< col style = "width: 33.3%" / >
< col style = "width: 66.7%" / >
< / colgroup >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > Options< / p > < / th >
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --days< / span > < / code > < / p > < / td >
< td > < p > Number of days.< / p > < / td >
< / tr >
< / tbody >
< / table >
2023-06-18 15:02:21 +02:00
< / div >
2022-09-15 16:11:13 +02:00
< / section >
2023-04-12 17:32:08 +02:00
< section id = "ftcli-users-create" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > create< / span > < / code > < a class = "headerlink" href = "#ftcli-users-create" title = "Permalink to this heading" > #< / a > < / h3 >
2023-04-12 17:32:08 +02:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.7.15.< / span > < / p >
< / div >
< p > Create a user account.< / p >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< ul class = "simple" >
< li > < p > the newly created account is already active.< / p > < / li >
< li > < p > the CLI allows to create users when registration is disabled.< / p > < / li >
< / ul >
< / div >
2023-06-18 15:02:21 +02:00
< div class = "table-wrapper colwidths-given table-bordered docutils container" >
2023-04-12 17:32:08 +02:00
< table class = "table-bordered docutils align-default" >
< colgroup >
< col style = "width: 33.3%" / >
< col style = "width: 66.7%" / >
< / colgroup >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > Arguments/options< / p > < / th >
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > USERNAME< / span > < / code > < / p > < / td >
< td > < p > Username.< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --email< / span > < span class = "pre" > EMAIL< / span > < / code > < / p > < / td >
< td > < p > User email (mandatory).< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --password< / span > < span class = "pre" > PASSWORD< / span > < / code > < / p > < / td >
< td > < p > User password (if not provided, a random password is generated).< / p > < / td >
< / tr >
< / tbody >
< / table >
2023-06-18 15:02:21 +02:00
< / div >
2023-04-12 17:32:08 +02:00
< / section >
2023-03-05 14:26:31 +01:00
< section id = "ftcli-users-export-archives" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > export_archives< / span > < / code > < a class = "headerlink" href = "#ftcli-users-export-archives" title = "Permalink to this heading" > #< / a > < / h3 >
2023-03-05 14:26:31 +01:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.7.13.< / span > < / p >
< / div >
< p > Process incomplete user export requests.
Can be used if redis is not set (no dramatiq workers running).< / p >
2023-06-18 15:02:21 +02:00
< div class = "table-wrapper colwidths-given table-bordered docutils container" >
2023-03-05 14:26:31 +01:00
< table class = "table-bordered docutils align-default" >
< colgroup >
< col style = "width: 33.3%" / >
< col style = "width: 66.7%" / >
< / colgroup >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > Options< / p > < / th >
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --max< / span > < / code > < / p > < / td >
< td > < p > Maximum number of export requests to process.< / p > < / td >
< / tr >
< / tbody >
< / table >
2023-06-18 15:02:21 +02:00
< / div >
2023-03-05 14:26:31 +01:00
< / section >
2022-04-24 13:17:38 +02:00
< section id = "ftcli-users-update" >
2023-06-18 15:02:21 +02:00
< h3 > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > update< / span > < / code > < a class = "headerlink" href = "#ftcli-users-update" title = "Permalink to this heading" > #< / a > < / h3 >
2022-04-24 13:17:38 +02:00
< div class = "versionadded" >
< p > < span class = "versionmodified added" > New in version 0.6.5.< / span > < / p >
< / div >
< p > Modify a user account (admin rights, active status, email and password).< / p >
2023-06-18 15:02:21 +02:00
< div class = "table-wrapper colwidths-given table-bordered docutils container" >
2022-06-22 20:22:26 +02:00
< table class = "table-bordered docutils align-default" >
2022-04-24 13:17:38 +02:00
< colgroup >
2022-07-27 11:10:29 +02:00
< col style = "width: 33.3%" / >
< col style = "width: 66.7%" / >
2022-04-24 13:17:38 +02:00
< / colgroup >
< thead >
2023-04-12 17:32:08 +02:00
< tr class = "row-odd" > < th class = "head" > < p > Arguments/options< / p > < / th >
2022-04-24 13:17:38 +02:00
< th class = "head" > < p > Description< / p > < / th >
< / tr >
< / thead >
< tbody >
2023-04-12 17:32:08 +02:00
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > USERNAME< / span > < / code > < / p > < / td >
< td > < p > Username.< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --set-admin< / span > < span class = "pre" > BOOLEAN< / span > < / code > < / p > < / td >
2022-04-24 13:17:38 +02:00
< td > < p > Add/remove admin rights (when adding admin rights, it also activates user account if not active).< / p > < / td >
< / tr >
2023-04-12 17:32:08 +02:00
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --activate< / span > < / code > < / p > < / td >
2022-04-24 13:17:38 +02:00
< td > < p > Activate user account.< / p > < / td >
< / tr >
2023-04-12 17:32:08 +02:00
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --reset-password< / span > < / code > < / p > < / td >
2022-04-24 13:17:38 +02:00
< td > < p > Reset user password (a new password will be displayed).< / p > < / td >
< / tr >
2023-04-12 17:32:08 +02:00
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > --update-email< / span > < span class = "pre" > EMAIL< / span > < / code > < / p > < / td >
2022-04-24 13:17:38 +02:00
< td > < p > Update user email.< / p > < / td >
< / tr >
< / tbody >
< / table >
2023-06-18 15:02:21 +02:00
< / div >
2022-04-24 13:17:38 +02:00
< / section >
< / section >
< / section >
2023-06-18 15:02:21 +02:00
< / article >
< / div >
< footer >
< div class = "related-pages" >
< a class = "next-page" href = "third_party_tools.html" >
< div class = "page-info" >
< div class = "context" >
< span > Next< / span >
< / div >
< div class = "title" > Third-party tools< / div >
< / div >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< / a >
< a class = "prev-page" href = "installation.html" >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< div class = "page-info" >
< div class = "context" >
< span > Previous< / span >
< / div >
< div class = "title" > Installation< / div >
< / div >
< / a >
< / div >
< div class = "bottom-of-page" >
< div class = "left-details" >
< div class = "copyright" >
2024-02-04 17:12:04 +01:00
Copyright © 2018 - 2024, SamR1
2023-06-18 15:02:21 +02:00
< / div >
Made with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > and < a class = "muted-link" href = "https://pradyunsg.me" > @pradyunsg< / a > 's
< a href = "https://github.com/pradyunsg/furo" > Furo< / a >
< / div >
< div class = "right-details" >
< div class = "icons" >
< a class = "muted-link fa fa-github fa-lg" href = "https://github.com/SamR1/FitTrackee" aria-label = "GitHub" > < / a >
2023-06-28 08:44:42 +02:00
< a class = "muted-link fa fa-mastodon fa-lg" rel = "me" href = "https://fosstodon.org/@FitTrackee" aria-label = "Mastodon" > < / a >
2023-06-18 15:02:21 +02:00
< / div >
< / div >
< / div >
< / footer >
2022-04-24 13:17:38 +02:00
< / div >
2023-06-18 15:02:21 +02:00
< aside class = "toc-drawer" >
2022-04-24 13:17:38 +02:00
2023-06-18 15:02:21 +02:00
< div class = "toc-sticky toc-scroll" >
< div class = "toc-title-container" >
< span class = "toc-title" >
On this page
< / span >
< / div >
< div class = "toc-tree-container" >
< div class = "toc-tree" >
< ul >
< li > < a class = "reference internal" href = "#" > Command line interface< / a > < ul >
< li > < a class = "reference internal" href = "#database" > Database< / a > < ul >
< li > < a class = "reference internal" href = "#ftcli-db-drop" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > db< / span > < span class = "pre" > drop< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#ftcli-db-upgrade" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > db< / span > < span class = "pre" > upgrade< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#oauth2" > OAuth2< / a > < ul >
< li > < a class = "reference internal" href = "#ftcli-oauth2-clean" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > oauth2< / span > < span class = "pre" > clean< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#users" > Users< / a > < ul >
< li > < a class = "reference internal" href = "#ftcli-users-clean-archives" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > clean_archives< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#ftcli-users-clean-tokens" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > clean_tokens< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#ftcli-users-create" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > create< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#ftcli-users-export-archives" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > export_archives< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#ftcli-users-update" > < code class = "docutils literal notranslate" > < span class = "pre" > ftcli< / span > < span class = "pre" > users< / span > < span class = "pre" > update< / span > < / code > < / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2022-11-27 12:06:42 +01:00
2023-06-18 15:02:21 +02:00
< / div >
< / div >
< / div >
< / aside >
< / div >
2024-02-04 17:12:04 +01:00
< / div > < script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js?v=65d44590" > < / script >
2023-07-30 17:05:25 +02:00
< script src = "_static/doctools.js?v=888ff710" > < / script >
< script src = "_static/sphinx_highlight.js?v=4825356b" > < / script >
< script src = "_static/scripts/furo.js?v=32e29ea5" > < / script >
< script src = "_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "_static/copybutton.js?v=f281be69" > < / script >
2023-06-18 15:02:21 +02:00
< / body >
2022-04-24 13:17:38 +02:00
< / html >
