Skip to content

Commit

Permalink
Deployed 97ba901 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@sylvaingaudan
sylvaingaudan committed Sep 16, 2024
1 parent 9979b8b commit 088c7c1
Show file tree
Hide file tree
Showing 8 changed files with 89 additions and 89 deletions.
6 changes: 3 additions & 3 deletions collections/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -609,15 +609,15 @@
<h1>Collections</h1>

<h2 id="list-collections-management-commands">List collections management commands</h2>
<div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli collections --help</span><span data-ty>Usage: python -m arlas.cli.cli collections [OPTIONS] COMMAND [ARGS]...<br><br>Options:<br> --config TEXT Name of the ARLAS configuration to use from your<br> configuration file<br> (/Users/gaudan/.arlas/cli/configuration.yaml). [required]<br> --help Show this message and exit.<br><br>Commands:<br> count Count the number of hits within a collection (or all...<br> create Create a collection<br> delete Delete a collection<br> describe Describe a collection<br> list List collections<br> sample Display a sample of a collection<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 collections --help</span><span data-ty> <br> Usage: python -m arlas.cli.cli collections [OPTIONS] COMMAND <br> [ARGS]... <br> <br>╭─ Options ──────────────────────────────────────────────────────────╮<br>│ * --config TEXT Name of the ARLAS configuration to use │<br>│ from your configuration file │<br>│ (/Users/gaudan/.arlas/cli/configuration.… │<br>│ [default: None] │<br>│ [required] │<br>│ --help Show this message and exit. │<br>╰────────────────────────────────────────────────────────────────────╯<br>╭─ Commands ─────────────────────────────────────────────────────────╮<br>│ count Count the number of hits within a collection (or all │<br>│ collection if not provided) │<br>│ create Create a collection │<br>│ delete Delete a collection │<br>│ describe Describe a collection │<br>│ list List collections │<br>│ name Set the collection display name │<br>│ private Set collection visibility to private │<br>│ public Set collection visibility to public │<br>│ sample Display a sample of a collection │<br>│ share Share the collection with the organisation │<br>│ unshare Share the collection with the organisation │<br>╰────────────────────────────────────────────────────────────────────╯<br><br></span></div>

<h2 id="create-a-collection">Create a collection</h2>
<p>You can create a collection from scratch or by providing a collection model (<code>--model</code>). The command line options let you specify how the index should be used by the collection. The visibility options (<code>--public</code>, <code>--owner</code> and <code>--orgs</code>) allow you to choose who can access the collection.</p>
<div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli collections --config local create --help</span><span data-ty>Usage: python -m arlas.cli.cli collections create [OPTIONS] COLLECTION<br><br> Create a collection<br><br>Arguments:<br> COLLECTION Collection's name [required]<br><br>Options:<br> --model TEXT Name of the model within your configuration, or URL<br> or file path<br> --index TEXT Name of the index referenced by the collection<br> --display-name TEXT Display name of the collection<br> --public / --no-public Whether the collection is public or not [default:<br> no-public]<br> --owner TEXT Organisation's owner<br> --orgs TEXT List of organisations accessing the collection<br> --id-path TEXT Overide the JSON path to the id field.<br> --centroid-path TEXT Overide the JSON path to the centroid field.<br> --geometry-path TEXT Overide the JSON path to the geometry field.<br> --date-path TEXT Overide the JSON path to the date field.<br> --help Show this message and exit.<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 collections --config local create --help</span><span data-ty> <br> Usage: python -m arlas.cli.cli collections create [OPTIONS] <br> COLLECTION <br> <br> Create a collection <br> <br>╭─ Arguments ────────────────────────────────────────────────────────╮<br>│ * collection TEXT Collection's name [default: None] │<br>│ [required] │<br>╰────────────────────────────────────────────────────────────────────╯<br>╭─ Options ──────────────────────────────────────────────────────────╮<br>│ --model TEXT Name of the model within │<br>│ your configuration, or URL │<br>│ or file path │<br>│ [default: None] │<br>│ --index TEXT Name of the index │<br>│ referenced by the │<br>│ collection │<br>│ [default: None] │<br>│ --display-name TEXT Display name of the │<br>│ collection │<br>│ [default: None] │<br>│ --public --no-public Whether the collection is │<br>│ public or not │<br>│ [default: no-public] │<br>│ --owner TEXT Organisation's owner │<br>│ [default: None] │<br>│ --orgs TEXT List of organisations │<br>│ accessing the collection │<br>│ --id-path TEXT Overide the JSON path to │<br>│ the id field. │<br>│ [default: None] │<br>│ --centroid-path TEXT Overide the JSON path to │<br>│ the centroid field. │<br>│ [default: None] │<br>│ --geometry-path TEXT Overide the JSON path to │<br>│ the geometry field. │<br>│ [default: None] │<br>│ --date-path TEXT Overide the JSON path to │<br>│ the date field. │<br>│ [default: None] │<br>│ --help Show this message and │<br>│ exit. │<br>╰────────────────────────────────────────────────────────────────────╯<br><br></span></div>

<h2 id="describe-a-collection">Describe a collection</h2>
<p>This command line provides a description of the collection structure (fields) and of its metadata.</p>
<div class="termy" data-termynal data-ty-macos data-ty-title="bash"><span data-ty="input" data-ty-prompt="&gt;">arlas_cli collections --config local describe --help</span><span data-ty>Usage: python -m arlas.cli.cli collections describe [OPTIONS] COLLECTION<br><br> Describe a collection<br><br>Arguments:<br> COLLECTION Collection's name [required]<br><br>Options:<br> --help Show this message and exit.<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 collections --config local describe --help</span><span data-ty> <br> Usage: python -m arlas.cli.cli collections describe [OPTIONS] <br> COLLECTION <br> <br> Describe a collection <br> <br>╭─ Arguments ────────────────────────────────────────────────────────╮<br>│ * collection TEXT Collection's name [default: None] │<br>│ [required] │<br>╰────────────────────────────────────────────────────────────────────╯<br>╭─ Options ──────────────────────────────────────────────────────────╮<br>│ --help Show this message and exit. │<br>╰────────────────────────────────────────────────────────────────────╯<br><br></span></div>



Expand Down
Loading

0 comments on commit 088c7c1

Please sign in to comment.