CINXE.COM

<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <title>CLI - Gancio</title> <link href="https://github.com/lesion" rel="me"> <link href="eventi@cisti.org" rel="me"> <link rel="webmention" href="https://webmention.io/gancio.org/webmention" /> <link rel="pingback" href="https://webmention.io/gancio.org/xmlrpc" /> <link rel="shortcut icon" href="https://gancio.org/favicon.ico" type="image/x-icon"> <link rel="stylesheet" href="https://gancio.org/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="https://gancio.org/assets/css/premonition.css"> <script type="text/javascript" src="https://gancio.org/assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="https://gancio.org/assets/js/just-the-docs.js"></script> <script src="https://gancio.org/assets/js/jquery-3.3.1.min.js"></script> <link rel="stylesheet" href="https://gancio.org/assets/css/jquery.fancybox.min.css"> <script src="https://gancio.org/assets/js/jquery.fancybox.min.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1">  <title>CLI | Gancio</title> <meta name="generator" content="Jekyll v4.3.2" /> <meta property="og:title" content="CLI" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="A shared agenda for local communities with AP support" /> <meta property="og:description" content="A shared agenda for local communities with AP support" /> <link rel="canonical" href="https://gancio.org/usage/cli" /> <meta property="og:url" content="https://gancio.org/usage/cli" /> <meta property="og:site_name" content="Gancio" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="CLI" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"A shared agenda for local communities with AP support","headline":"CLI","url":"https://gancio.org/usage/cli"}</script>  </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather 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" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol>  <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol>  <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> Gancio </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Usage category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/usage" class="nav-list-link">Usage</a><ul class="nav-list"><li class="nav-list-item"><a href="/usage/embed" class="nav-list-link">Embed events in webpages</a></li><li class="nav-list-item"><a href="/usage/moderation" class="nav-list-link">Moderation</a></li><li class="nav-list-item"><a href="/usage/users" class="nav-list-link">Users</a></li><li class="nav-list-item"><a href="/usage/cli" class="nav-list-link">CLI</a></li><li class="nav-list-item"><a href="/usage/federation" class="nav-list-link">Federation</a></li><li class="nav-list-item"><a href="/usage/plugins" class="nav-list-link">Plugins</a></li><li class="nav-list-item"><a href="/usage/custom_css" class="nav-list-link">Custom CSS</a></li><li class="nav-list-item"><a href="/usage/custom_js" class="nav-list-link">Custom Javascript</a></li></ul></li><li class="nav-list-item"><a href="/screenshot" class="nav-list-link">Screenshots</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Install category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/install" class="nav-list-link">Install</a><ul class="nav-list"><li class="nav-list-item"><a href="/install/debian" class="nav-list-link">Debian</a></li><li class="nav-list-item"><a href="/install/nixos" class="nav-list-link">NixOS</a></li><li class="nav-list-item"><a href="/install/docker" class="nav-list-link">Docker</a></li><li class="nav-list-item"><a href="/install/backup" class="nav-list-link">Backup</a></li><li class="nav-list-item"><a href="/install/config" class="nav-list-link">Configuration</a></li><li class="nav-list-item"><a href="/install/nominatim" class="nav-list-link">Nominatim</a></li><li class="nav-list-item"><a href="/install/nginx" class="nav-list-link">Nginx setup</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Hacking category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/dev" class="nav-list-link">Hacking</a><ul class="nav-list"><li class="nav-list-item"><a href="/dev/structure" class="nav-list-link">Project Structure</a></li><li class="nav-list-item"><a href="/dev/plugins" class="nav-list-link">Plugins</a></li><li class="nav-list-item"><a href="/dev/oauth" class="nav-list-link">OAuth</a></li><li class="nav-list-item"><a href="/dev/locales" class="nav-list-link">Internationalization</a></li><li class="nav-list-item"><a href="/dev/api" class="nav-list-link">API</a></li></ul></li><li class="nav-list-item"><a href="/contribute" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/instances" class="nav-list-link">Instances</a></li><li class="nav-list-item"><a href="/about" class="nav-list-link">About</a></li><li class="nav-list-item"><a href="/contacts" class="nav-list-link">Contacts</a></li><li class="nav-list-item"><a href="/federation" class="nav-list-link">Federation</a></li><li class="nav-list-item"><a href="/changelog" class="nav-list-link">Changelog</a></li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search Gancio" aria-label="Search Gancio" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="https://framagit.org/les/gancio" class="site-button" > Source </a> </li> <li class="aux-nav-list-item"> <a href="https://mastodon.cisti.org/@gancio" class="site-button" > @gancio@mastodon.cisti.org </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/usage">Usage</a></li> <li class="breadcrumb-nav-list-item"><span>CLI</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 class="no_toc" id="cli---command-line-interface"> <a href="#cli---command-line-interface" class="anchor-heading" aria-labelledby="cli---command-line-interface"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> CLI - Command Line Interface </h1> <ol id="markdown-toc"> <li><a href="#using-cli" id="markdown-toc-using-cli">Using CLI</a> <ol> <li><a href="#using-cli-with-docker-installation" id="markdown-toc-using-cli-with-docker-installation">Using CLI with Docker installation</a></li> </ol> </li> <li><a href="#users-since-1614" id="markdown-toc-users-since-1614">Users <span class="label label-yellow">since 1.6.14</span></a> <ol> <li><a href="#list-all-users" id="markdown-toc-list-all-users">List all users</a></li> <li><a href="#create-a-new-user" id="markdown-toc-create-a-new-user">Create a new user</a></li> <li><a href="#remove-a-user" id="markdown-toc-remove-a-user">Remove a user</a></li> <li><a href="#reset-password" id="markdown-toc-reset-password">Reset password</a></li> <li><a href="#change-role" id="markdown-toc-change-role">Change role</a></li> <li><a href="#enable--disable-users" id="markdown-toc-enable--disable-users">Enable / disable users</a></li> </ol> </li> <li><a href="#settings-since-1240" id="markdown-toc-settings-since-1240">Settings <span class="label label-yellow">since 1.24.0</span></a> <ol> <li><a href="#list-all-settings" id="markdown-toc-list-all-settings">List all settings</a></li> <li><a href="#get-a-specific-setting-value" id="markdown-toc-get-a-specific-setting-value">Get a specific setting value</a></li> <li><a href="#set-a-specific-setting-value" id="markdown-toc-set-a-specific-setting-value">Set a specific setting value</a></li> </ol> </li> </ol> <h2 id="using-cli"> <a href="#using-cli" class="anchor-heading" aria-labelledby="using-cli"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Using CLI </h2> <p>Gancio is distributed with an embedded CLI. To use the CLI you need to specify the <code class="language-plaintext highlighter-rouge">config.json</code> configuration file via <code class="language-plaintext highlighter-rouge">--config <your_config.json></code> flag; by default the CLI will look for one in the current directory, so if your current directory is /opt/gancio (having followed the <a href="/install/debian">installation instructions</a>) there is no need to specify it.</p> <h3 id="using-cli-with-docker-installation"> <a href="#using-cli-with-docker-installation" class="anchor-heading" aria-labelledby="using-cli-with-docker-installation"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Using CLI with Docker installation </h3> <p>To use the CLI in a docker installation you can execute a shell inside the container with: <code class="language-plaintext highlighter-rouge">docker exec --workdir /home/node/data -it gancio sh</code> and following the normal CLI usage or running commands with:</p> <p><code class="language-plaintext highlighter-rouge">docker exec --workdir /home/node/data gancio gancio <your command></code></p> <p>(the first “gancio” is the container name)</p> <h2 id="users-since-1614"> <a href="#users-since-1614" class="anchor-heading" aria-labelledby="users-since-1614"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Users <span class="label label-yellow">since 1.6.14</span> </h2> <p>All users related sub-commands starts with <code class="language-plaintext highlighter-rouge">gancio users</code>. Note that most of this actions could be done from administration panel (Admin > Users).</p> <h3 id="list-all-users"> <a href="#list-all-users" class="anchor-heading" aria-labelledby="list-all-users"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> List all users </h3> <p>To list all users use <code class="language-plaintext highlighter-rouge">gancio users list</code></p> <h3 id="create-a-new-user"> <a href="#create-a-new-user" class="anchor-heading" aria-labelledby="create-a-new-user"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Create a new user </h3> <p><code class="language-plaintext highlighter-rouge">gancio users create <username|email> [password] [role]</code></p> <p><code class="language-plaintext highlighter-rouge">role</code> value could be <code class="language-plaintext highlighter-rouge">user</code> (default), <code class="language-plaintext highlighter-rouge">admin</code> or <code class="language-plaintext highlighter-rouge">editor</code>, you can also specify it using <code class="language-plaintext highlighter-rouge">--role</code> flag.<br /> To create an user with administrator privileges use the <code class="language-plaintext highlighter-rouge">--role</code> flag, e.g.<br /> <code class="language-plaintext highlighter-rouge">gancio users create admin@example.com --role admin</code></p> <h3 id="remove-a-user"> <a href="#remove-a-user" class="anchor-heading" aria-labelledby="remove-a-user"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Remove a user </h3> <p><code class="language-plaintext highlighter-rouge">gancio users remove <username|email></code></p> <h3 id="reset-password"> <a href="#reset-password" class="anchor-heading" aria-labelledby="reset-password"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Reset password </h3> <p><code class="language-plaintext highlighter-rouge">gancio users reset-password <username|email></code></p> <h3 id="change-role"> <a href="#change-role" class="anchor-heading" aria-labelledby="change-role"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Change role </h3> <p>To add administrator privileges to an user: <code class="language-plaintext highlighter-rouge">gancio users set_role <username|email> admin</code></p> <p>To remove administrator privileges from an user: <code class="language-plaintext highlighter-rouge">gancio users set_role <username|email> user</code></p> <h3 id="enable--disable-users"> <a href="#enable--disable-users" class="anchor-heading" aria-labelledby="enable--disable-users"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Enable / disable users </h3> <p>To enable an user: <code class="language-plaintext highlighter-rouge">gancio users enable <email></code></p> <p>To disable an user: <code class="language-plaintext highlighter-rouge">gancio users disable <email></code></p> <h2 id="settings-since-1240"> <a href="#settings-since-1240" class="anchor-heading" aria-labelledby="settings-since-1240"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Settings <span class="label label-yellow">since 1.24.0</span> </h2> <p>All settings related sub-commands starts with <code class="language-plaintext highlighter-rouge">gancio settings</code>. Note that most of this actions could be done from administration panel.</p> <h3 id="list-all-settings"> <a href="#list-all-settings" class="anchor-heading" aria-labelledby="list-all-settings"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> List all settings </h3> <p>To list all settings use <code class="language-plaintext highlighter-rouge">gancio settings list</code></p> <h3 id="get-a-specific-setting-value"> <a href="#get-a-specific-setting-value" class="anchor-heading" aria-labelledby="get-a-specific-setting-value"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Get a specific setting value </h3> <p><code class="language-plaintext highlighter-rouge">gancio settings get <setting></code></p> <h3 id="set-a-specific-setting-value"> <a href="#set-a-specific-setting-value" class="anchor-heading" aria-labelledby="set-a-specific-setting-value"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Set a specific setting value </h3> <p><code class="language-plaintext highlighter-rouge">gancio settings set <setting> <value></code></p> <div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># change federated actor's name</span> ➜ gancio settings <span class="nb">set </span>instance_name <span class="s1">'"gancio"'</span> 📅 gancio - v1.24.0 - A shared agenda <span class="k">for </span><span class="nb">local </span>communities <span class="o">(</span>nodejs: v20.15.0<span class="o">)</span> <span class="o">></span> Reading configuration from: /home/les/dev/hacklab/gancio/config.json instance_name Old value: <span class="s2">"relay"</span> New value: <span class="s2">"gancio"</span> Note that this will likely <span class="nb">break </span>current federation <span class="o">(</span>all your follower / following connections will be destroyed<span class="o">)!</span> Note that a restart is needed to get the new setting </code></pre></div></div> <div class="premonition warning"> <i class="premonition pn-warn"></i> <div class="content"> <p class="header">JSON</p><p>Note that settings are stored in JSON, so your value will be parsed.</p> </div> </div> <div class="premonition warning"> <i class="premonition pn-warn"></i> <div class="content"> <p class="header">Restart needed</p><p>A restart is needed after a setting is changed</p> </div> </div> <div class="premonition info"> <i class="premonition pn-info"></i> <div class="content"> <p class="header">References</p><p><a href="https://framagit.org/les/gancio/-/issues/365">#365</a></p> </div> </div> </main> <hr> <footer> <div class="d-flex mt-2"> <p class="text-small text-grey-dk-000 mb-0"> <a href="https://framagit.org/les/gancio/-/tree/master/docs/usage/cli.md" id="edit-this-page">Edit this page</a> </p> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>