Deployed 0b166c6 with MkDocs version: 1.6.0

404.html

@@ -381,6 +381,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/arlas_cli/iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="/arlas_cli/confs/" class="md-nav__link">
 

arlas_cloud/index.html

@@ -385,6 +385,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

collections/index.html

@@ -457,6 +457,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

collections_1/index.html

@@ -388,6 +388,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

collections_2/index.html

@@ -388,6 +388,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

collections_3/index.html

@@ -388,6 +388,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

collections_4/index.html

@@ -383,6 +383,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

confs/index.html

@@ -15,7 +15,7 @@
         <link rel="canonical" href="https://gisaia.github.io/arlas_cli/confs/">
 
 
-        <link rel="prev" href="../persist/">
+        <link rel="prev" href="../iam/">
 
 
         <link rel="next" href="../model/model/">
@@ -392,6 +392,27 @@
 
 
 
+
+
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
 
 
 

confs_1/index.html

@@ -388,6 +388,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

confs_2/index.html

@@ -388,6 +388,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

confs_3/index.html

@@ -383,6 +383,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 

help/index.html

@@ -439,6 +439,27 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../iam/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Identity & Access
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../confs/" class="md-nav__link">
 
@@ -554,10 +575,30 @@ <h1>Getting help</h1>
 <h2 id="getting-help">Getting help</h2>
 <p>At any time, if you need some help on how to use the command line or one of its sub command, simply add <code>--help</code>.</p>
 <p>Whether you are at the top level:</p>
-<div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli --help</span><span data-ty> Usage: arlas_cli [OPTIONS] COMMAND [ARGS]...                         <br>                                                                      <br>╭─ Options ──────────────────────────────────────────────────────────╮<br>│ --config-file        TEXT  Path to the configuration file if you   │<br>│                            do not want to use the default one:     │<br>│                            .arlas/cli/configuration.yaml.          │<br>│                            [default: None]                         │<br>│ --version                  Print command line version              │<br>│ --help                     Show this message and exit.             │<br>╰────────────────────────────────────────────────────────────────────╯<br>╭─ Commands ─────────────────────────────────────────────────────────╮<br>│ collections                                                        │<br>│ confs                                                              │<br>│ indices                                                            │<br>│ persist                                                            │<br>╰────────────────────────────────────────────────────────────────────╯<br></span></div>
+<div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli --help</span><span data-ty>Usage: arlas_cli [OPTIONS] COMMAND [ARGS]...<br><br>Options:<br>  --config-file TEXT  Path to the configuration file if you do not want to use<br>                      the default one: .arlas/cli/configuration.yaml.<br>  --version           Print command line version<br>  --help              Show this message and exit.<br><br>Commands:<br>  collections<br>  confs<br>  iam<br>  indices<br>  persist<br></span></div>
 
 <p>or within a sub command:</p>
-<div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli indices --config demo mapping --help</span><span data-ty>╭─ Arguments ────────────────────────────────────────────────────────╮<br>│ *    file      TEXT  Path to the file conaining the data. Format:  │<br>│                      NDJSON                                        │<br>│                      [default: None]                               │<br>│                      [required]                                    │<br>╰────────────────────────────────────────────────────────────────────╯<br>╭─ Options ──────────────────────────────────────────────────────────╮<br>│ --nb-lines             INTEGER  Number of line to consider for     │<br>│                                 generating the mapping. Avoid      │<br>│                                 going over 10.                     │<br>│                                 [default: 2]                       │<br>│ --field-mapping        TEXT     Overide the mapping with the       │<br>│                                 provided field/type. Example:      │<br>│                                 fragment.location:geo_point        │<br>│ --push-on              TEXT     Push the generated mapping for the │<br>│                                 provided index name                │<br>│                                 [default: None]                    │<br>│ --help                          Show this message and exit.        │<br>╰────────────────────────────────────────────────────────────────────╯<br><br></span></div>
+<!-- termynal -->
+<p>```shell</p>
+<blockquote>
+<p>arlas_cli indices --config demo mapping --help
+Usage: arlas_cli indices mapping [OPTIONS] FILE</p>
+</blockquote>
+<p>Generate the mapping based on the data</p>
+<p>Arguments:
+  FILE  Path to the file conaining the data. Format: NDJSON  [required]</p>
+<p>Options:
+  --nb-lines INTEGER    Number of line to consider for generating the mapping.
+                        Avoid going over 10.  [default: 2]
+  --field-mapping TEXT  Overide the mapping with the provided field path/type.
+                        Example: fragment.location:geo_point. Important: the
+                        full field path must be provided.
+  --no-fulltext TEXT    List of keyword or text fields that should not be in
+                        the fulltext search. Important: the field name only
+                        must be provided.
+  --push-on TEXT        Push the generated mapping for the provided index name
+  --help                Show this message and exit.
+  ```</p>