server/cli/index.html - gerrit/www.eclipse.org/hawk - Git at Google



 <!doctype html>
 <html lang="en" class="no-js">
   <head>

       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       <meta http-equiv="x-ua-compatible" content="ie=edge">


         <meta name="lang:clipboard.copy" content="Copy to clipboard">

         <meta name="lang:clipboard.copied" content="Copied to clipboard">

         <meta name="lang:search.language" content="en">

         <meta name="lang:search.pipeline.stopwords" content="True">

         <meta name="lang:search.pipeline.trimmer" content="True">

         <meta name="lang:search.result.none" content="No matching documents">

         <meta name="lang:search.result.one" content="1 matching document">

         <meta name="lang:search.result.other" content="# matching documents">

         <meta name="lang:search.tokenizer" content="[\s\-]+">

       <link rel="shortcut icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">


         <title>Console client - Eclipse Hawk</title>


       <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">

         <link rel="stylesheet" href="../../assets/stylesheets/application-palette.a8b3c06d.css">


         <meta name="theme-color" content="#7e57c2">


       <script src="../../assets/javascripts/modernizr.74668098.js"></script>


         <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
         <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>


     <link rel="stylesheet" href="../../assets/fonts/material-icons.css">

       <link rel="manifest" href="../../assets/images/site.webmanifest">


       <link rel="stylesheet" href="../../stylesheets/extra.css">


 <!-- FAVICON -->
 <link rel="apple-touch-icon" sizes="180x180" href="../../assets/images/apple-touch-icon.png">
 <link rel="icon" type="image/png" sizes="32x32" href="../../assets/images/favicon-32x32.png">
 <link rel="icon" type="image/png" sizes="16x16" href="../../assets/images/favicon-16x16.png">
 <link rel="mask-icon" href="../../assets/images/safari-pinned-tab.svg" color="#5bbad5">
 <link rel="shortcut icon" href="../../assets/images/favicon.ico">
 <meta name="msapplication-TileColor" content="#b91d47">
 <meta name="msapplication-config" content="../../assets/images/browserconfig.xml">
 <meta name="theme-color" content="#ffffff">

   </head>


     <body dir="ltr" data-md-color-primary="deep-purple" data-md-color-accent="deep-purple">

     <svg class="md-svg">
       <defs>


       </defs>
     </svg>
     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>

       <a href="#hawk" tabindex="1" class="md-skip">
         Skip to content
       </a>


       <header class="md-header" data-md-component="header">
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
         <a href="../.." title="Eclipse Hawk" class="md-header-nav__button md-logo">

             <img src="../../assets/images/hawk-logo-white.svg" width="24" height="24">

         </a>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">

             <span class="md-header-nav__topic">
               Eclipse Hawk
             </span>
             <span class="md-header-nav__topic">

                 Console client

             </span>

         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">

           <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>

 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
     <form class="md-search__form" name="search">
       <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
       <label class="md-icon md-search__icon" for="__search"></label>
       <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
         &#xE5CD;
       </button>
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
         <div class="md-search-result" data-md-component="result">
           <div class="md-search-result__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
         </div>
       </div>
     </div>
   </div>
 </div>

       </div>

         <div class="md-flex__cell md-flex__cell--shrink">
           <div class="md-header-nav__source">


 <a href="https://git.eclipse.org/c/hawk/hawk.git/" title="Go to repository" class="md-source" data-md-source="">

   <div class="md-source__repository">
     Git repository @ Eclipse
   </div>
 </a>
           </div>
         </div>

     </div>
   </nav>
 </header>

     <div class="md-container">


       <main class="md-main" role="main">
         <div class="md-main__inner md-grid" data-md-component="container">


               <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">
                     <nav class="md-nav md-nav--primary" data-md-level="0">
   <label class="md-nav__title md-nav__title--site" for="__drawer">
     <a href="../.." title="Eclipse Hawk" class="md-nav__button md-logo">

         <img src="../../assets/images/hawk-logo-white.svg" width="48" height="48">

     </a>
     Eclipse Hawk
   </label>

     <div class="md-nav__source">


 <a href="https://git.eclipse.org/c/hawk/hawk.git/" title="Go to repository" class="md-source" data-md-source="">

   <div class="md-source__repository">
     Git repository @ Eclipse
   </div>
 </a>
     </div>

   <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../.." title="Home" class="md-nav__link">
       Home
     </a>
   </li>


   <li class="md-nav__item md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">

     <label class="md-nav__link" for="nav-2">
       Basic use
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-2">
         Basic use
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../../basic-use/installation/" title="Installation" class="md-nav__link">
       Installation
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../basic-use/core-concepts/" title="Core concepts" class="md-nav__link">
       Core concepts
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../basic-use/examples-xmi/" title="Examples (XMI)" class="md-nav__link">
       Examples (XMI)
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../basic-use/examples-modelio/" title="Examples (Modelio)" class="md-nav__link">
       Examples (Modelio)
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../basic-use/papyrus/" title="Papyrus UML support" class="md-nav__link">
       Papyrus UML support
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">

     <label class="md-nav__link" for="nav-3">
       Advanced use
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-3">
         Advanced use
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../../advanced-use/graph-as-emf/" title="Graph as EMF model" class="md-nav__link">
       Graph as EMF model
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../advanced-use/advanced-props/" title="Advanced properties" class="md-nav__link">
       Advanced properties
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../advanced-use/meta-queries/" title="Meta-level queries" class="md-nav__link">
       Meta-level queries
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../advanced-use/temporal-queries/" title="Temporal queries" class="md-nav__link">
       Temporal queries
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../advanced-use/oomph/" title="Oomph and Hawk" class="md-nav__link">
       Oomph and Hawk
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item md-nav__item--active md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>

     <label class="md-nav__link" for="nav-4">
       Server
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-4">
         Server
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../architecture/" title="Architecture" class="md-nav__link">
       Architecture
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../api/" title="Thrift API" class="md-nav__link">
       Thrift API
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../api-security/" title="Thrift API security" class="md-nav__link">
       Thrift API security
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../deployment/" title="Deployment" class="md-nav__link">
       Deployment
     </a>
   </li>


   <li class="md-nav__item md-nav__item--active">

     <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">


       <label class="md-nav__link md-nav__link--active" for="__toc">
         Console client
       </label>

     <a href="./" title="Console client" class="md-nav__link md-nav__link--active">
       Console client
     </a>


 <nav class="md-nav md-nav--secondary">


     <label class="md-nav__title" for="__toc">Table of contents</label>
     <ul class="md-nav__list" data-md-scrollfix>

         <li class="md-nav__item">
   <a href="#hawk" class="md-nav__link">
     Hawk
   </a>

     <nav class="md-nav">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#connecting-to-hawk" class="md-nav__link">
     Connecting to Hawk
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-hawk-indexer-instances" class="md-nav__link">
     Managing Hawk indexer instances
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-metamodels" class="md-nav__link">
     Managing metamodels
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-version-control-repositories" class="md-nav__link">
     Managing version control repositories
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#querying-models" class="md-nav__link">
     Querying models
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-derived-attributes" class="md-nav__link">
     Managing derived attributes
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-indexed-attributes" class="md-nav__link">
     Managing indexed attributes
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#watching-over-changes-in-remote-models" class="md-nav__link">
     Watching over changes in remote models
   </a>

 </li>

       </ul>
     </nav>

 </li>

         <li class="md-nav__item">
   <a href="#users" class="md-nav__link">
     Users
   </a>

 </li>


     </ul>

 </nav>

   </li>


   <li class="md-nav__item">
     <a href="../eclipse/" title="Eclipse client" class="md-nav__link">
       Eclipse client
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../file-config/" title="File-based configuration" class="md-nav__link">
       File-based configuration
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../logging/" title="Logging" class="md-nav__link">
       Logging
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">

     <label class="md-nav__link" for="nav-5">
       Developers
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-5">
         Developers
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../../developers/run-from-source/" title="Run GUI from source" class="md-nav__link">
       Run GUI from source
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../developers/server-from-source/" title="Run Server from source" class="md-nav__link">
       Run Server from source
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../developers/plain-maven/" title="Build with plain Maven" class="md-nav__link">
       Build with plain Maven
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../developers/website/" title="Work on the website" class="md-nav__link">
       Work on the website
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">

     <label class="md-nav__link" for="nav-6">
       Community
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-6">
         Community
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="https://www.eclipse.org/forums/index.php/f/442/" title="Forum" class="md-nav__link">
       Forum
     </a>
   </li>


   <li class="md-nav__item">
     <a href="https://gitlab.eclipse.org/eclipse/hawk/hawk/-/issues/new" title="File a bug" class="md-nav__link">
       File a bug
     </a>
   </li>


   <li class="md-nav__item">
     <a href="https://gitlab.eclipse.org/eclipse/hawk/hawk/-/issues" title="Open bugs" class="md-nav__link">
       Open bugs
     </a>
   </li>


   <li class="md-nav__item">
     <a href="https://ci.eclipse.org/hawk/" title="Builds" class="md-nav__link">
       Builds
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item">
     <a href="../../additional-resources/" title="Additional resources" class="md-nav__link">
       Additional resources
     </a>
   </li>


   </ul>
 </nav>
                   </div>
                 </div>
               </div>


               <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">

 <nav class="md-nav md-nav--secondary">


     <label class="md-nav__title" for="__toc">Table of contents</label>
     <ul class="md-nav__list" data-md-scrollfix>

         <li class="md-nav__item">
   <a href="#hawk" class="md-nav__link">
     Hawk
   </a>

     <nav class="md-nav">
       <ul class="md-nav__list">

           <li class="md-nav__item">
   <a href="#connecting-to-hawk" class="md-nav__link">
     Connecting to Hawk
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-hawk-indexer-instances" class="md-nav__link">
     Managing Hawk indexer instances
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-metamodels" class="md-nav__link">
     Managing metamodels
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-version-control-repositories" class="md-nav__link">
     Managing version control repositories
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#querying-models" class="md-nav__link">
     Querying models
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-derived-attributes" class="md-nav__link">
     Managing derived attributes
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#managing-indexed-attributes" class="md-nav__link">
     Managing indexed attributes
   </a>

 </li>

           <li class="md-nav__item">
   <a href="#watching-over-changes-in-remote-models" class="md-nav__link">
     Watching over changes in remote models
   </a>

 </li>

       </ul>
     </nav>

 </li>

         <li class="md-nav__item">
   <a href="#users" class="md-nav__link">
     Users
   </a>

 </li>


     </ul>

 </nav>
                   </div>
                 </div>
               </div>


           <div class="md-content">
             <article class="md-content__inner md-typeset">


                   <h1>Console client</h1>

                 <p>You can talk to a Hawk server from one of the console client products in the latest <a href="https://github.com/mondo-project/mondo-hawk/releases">release</a>. Using the product only requires unpacking the product and running the main executable within it. Alternatively, you could install the "Hawk CLI Feature" into your Eclipse instance and use these commands from the "Host OSGi Console" in the Console view.</p>
 <p>Each <a href="../api/">Thrift API</a> has its own set of commands.</p>
 <h2 id="hawk">Hawk<a class="headerlink" href="#hawk" title="Permanent link">&para;</a></h2>
 <p>You can use the <code>hawkHelp</code> command to list all the available commands.</p>
 <h3 id="connecting-to-hawk">Connecting to Hawk<a class="headerlink" href="#connecting-to-hawk" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkConnect &lt;url> [username] [password]</td>
 <td>Connects to a Thrift endpoint (guesses the protocol from the URL)</td>
 </tr>
 <tr>
 <td>hawkDisconnect</td>
 <td>Disconnects from the current Thrift endpoint</td>
 </tr>
 </tbody>
 </table>
 <h3 id="managing-hawk-indexer-instances">Managing Hawk indexer instances<a class="headerlink" href="#managing-hawk-indexer-instances" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkAddInstance &lt;name> &lt;backend> [minDelay] [maxDelay|0]</td>
 <td>Adds an instance with the provided name (if maxDelay = 0, periodic updates are disabled)</td>
 </tr>
 <tr>
 <td>hawkListBackends</td>
 <td>Lists the available Hawk backends</td>
 </tr>
 <tr>
 <td>hawkListInstances</td>
 <td>Lists the available Hawk instances</td>
 </tr>
 <tr>
 <td>hawkRemoveInstance &lt;name></td>
 <td>Removes an instance with the provided name, if it exists</td>
 </tr>
 <tr>
 <td>hawkSelectInstance &lt;name></td>
 <td>Selects the instance with the provided name</td>
 </tr>
 <tr>
 <td>hawkStartInstance &lt;name></td>
 <td>Starts the instance with the provided name</td>
 </tr>
 <tr>
 <td>hawkStopInstance &lt;name></td>
 <td>Stops the instance with the provided name</td>
 </tr>
 <tr>
 <td>hawkSyncInstance &lt;name> [waitForSync:true|false]</td>
 <td>Requests an immediate sync on the instance with the provided name</td>
 </tr>
 </tbody>
 </table>
 <h3 id="managing-metamodels">Managing metamodels<a class="headerlink" href="#managing-metamodels" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkListMetamodels</td>
 <td>Lists all registered metamodels in this instance</td>
 </tr>
 <tr>
 <td>hawkRegisterMetamodel &lt;files...></td>
 <td>Registers one or more metamodels</td>
 </tr>
 <tr>
 <td>hawkUnregisterMetamodel &lt;uri></td>
 <td>Unregisters the metamodel with the specified URI</td>
 </tr>
 </tbody>
 </table>
 <h3 id="managing-version-control-repositories">Managing version control repositories<a class="headerlink" href="#managing-version-control-repositories" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkAddRepository &lt;url> &lt;type> [user] [pwd]</td>
 <td>Adds a repository</td>
 </tr>
 <tr>
 <td>hawkListFiles &lt;url> [filepatterns...]</td>
 <td>Lists files within a repository</td>
 </tr>
 <tr>
 <td>hawkListRepositories</td>
 <td>Lists all registered metamodels in this instance</td>
 </tr>
 <tr>
 <td>hawkListRepositoryTypes</td>
 <td>Lists available repository types</td>
 </tr>
 <tr>
 <td>hawkRemoveRepository &lt;url></td>
 <td>Removes the repository with the specified URL</td>
 </tr>
 <tr>
 <td>hawkUpdateRepositoryCredentials &lt;url> &lt;user> &lt;pwd></td>
 <td>Changes the user/password used to monitor a repository</td>
 </tr>
 </tbody>
 </table>
 <h3 id="querying-models">Querying models<a class="headerlink" href="#querying-models" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkGetModel &lt;repo> [filepatterns...]</td>
 <td>Returns all the model elements of the specified files within the repo</td>
 </tr>
 <tr>
 <td>hawkGetRoots &lt;repo> [filepatterns...]</td>
 <td>Returns only the root model elements of the specified files within the repo</td>
 </tr>
 <tr>
 <td>hawkListQueryLanguages</td>
 <td>Lists all available query languages</td>
 </tr>
 <tr>
 <td>hawkQuery &lt;query> &lt;language> [repo] [files]</td>
 <td>Queries the index</td>
 </tr>
 <tr>
 <td>hawkResolveProxies &lt;ids...></td>
 <td>Retrieves model elements by ID</td>
 </tr>
 </tbody>
 </table>
 <h3 id="managing-derived-attributes">Managing derived attributes<a class="headerlink" href="#managing-derived-attributes" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkAddDerivedAttribute &lt;mmURI> &lt;mmType> &lt;name> &lt;type> &lt;lang> &lt;expr> [many|ordered|unique]*</td>
 <td>Adds a derived attribute</td>
 </tr>
 <tr>
 <td>hawkListDerivedAttributes</td>
 <td>Lists all available derived attributes</td>
 </tr>
 <tr>
 <td>hawkRemoveDerivedAttribute &lt;mmURI> &lt;mmType> &lt;name></td>
 <td>Removes a derived attribute, if it exists</td>
 </tr>
 </tbody>
 </table>
 <h3 id="managing-indexed-attributes">Managing indexed attributes<a class="headerlink" href="#managing-indexed-attributes" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkAddIndexedAttribute &lt;mmURI> &lt;mmType> &lt;name></td>
 <td>Adds an indexed attribute</td>
 </tr>
 <tr>
 <td>hawkListIndexedAttributes</td>
 <td>Lists all available indexed attributes</td>
 </tr>
 <tr>
 <td>hawkRemoveIndexedAttribute &lt;mmURI> &lt;mmType> &lt;name></td>
 <td>Removes an indexed attribute, if it exists</td>
 </tr>
 </tbody>
 </table>
 <h3 id="watching-over-changes-in-remote-models">Watching over changes in remote models<a class="headerlink" href="#watching-over-changes-in-remote-models" title="Permanent link">&para;</a></h3>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>hawkWatchModelChanges [default|temporary|durable] [client ID] [repo] [files...]</td>
 <td>Watches an Artemis message queue with detected model changes</td>
 </tr>
 </tbody>
 </table>
 <h2 id="users">Users<a class="headerlink" href="#users" title="Permanent link">&para;</a></h2>
 <p>The Users API has its own set of commands, which can be listed through <code>usersHelp</code>:</p>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>usersHelp</td>
 <td>Lists all the available commands for Users</td>
 </tr>
 <tr>
 <td>usersConnect &lt;url> [username] [password]</td>
 <td>Connects to a Thrift endpoint</td>
 </tr>
 <tr>
 <td>usersDisconnect</td>
 <td>Disconnects from the current Thrift endpoint</td>
 </tr>
 <tr>
 <td>usersAdd &lt;username> &lt;realname> &lt;isAdmin: true|false> [password]</td>
 <td>Adds the user to the database</td>
 </tr>
 <tr>
 <td>usersUpdateProfile &lt;username> &lt;realname> &lt;isAdmin: true|false></td>
 <td>Changes the personal information of a user</td>
 </tr>
 <tr>
 <td>usersUpdatePassword &lt;username> [password]</td>
 <td>Changes the password of a user</td>
 </tr>
 <tr>
 <td>usersRemove &lt;username></td>
 <td>Removes a user</td>
 </tr>
 <tr>
 <td>usersCheck &lt;username> [password]</td>
 <td>Validates credentials</td>
 </tr>
 </tbody>
 </table>


             </article>
           </div>
         </div>
       </main>


 <footer class="md-footer">

     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">

           <a href="../deployment/" title="Deployment" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
             <div class="md-flex__cell md-flex__cell--shrink">
               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
             </div>
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <span class="md-flex__ellipsis">
                 <span class="md-footer-nav__direction">
                   Previous
                 </span>
                 Deployment
               </span>
             </div>
           </a>


           <a href="../eclipse/" title="Eclipse client" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <span class="md-flex__ellipsis">
                 <span class="md-footer-nav__direction">
                   Next
                 </span>
                 Eclipse client
               </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink">
               <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
             </div>
           </a>

       </nav>
     </div>

   <div class="md-footer-meta md-typeset">
     <div class="md-footer-meta__inner md-grid">
       <div class="md-footer-copyright">

           <div class="md-footer-copyright__highlight">
             Copyright © Eclipse Foundation, Inc. All Rights Reserved.
           </div>

         powered by
         <a href="https://www.mkdocs.org">MkDocs</a>
         and
         <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
       </div>
       <div class="md-footer-copyright hawk-eclipse-links">
           <ul>
               <li><a href="https://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
               <li><a href="https://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
               <li><a href="https://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
           </ul>
       </div>

     </div>
   </div>
 </footer>

     </div>

       <script src="../../assets/javascripts/application.c648116f.js"></script>

       <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>


   </body>
 </html>