File: cli.rst

package info (click to toggle)
stactools 0.5.3-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 23,796 kB
  • sloc: python: 4,498; xml: 554; sh: 395; makefile: 34
file content (33 lines) | stat: -rw-r--r-- 986 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
.. _cli:
.. highlight:: shell


Command line interface (CLI)
============================

``stactools`` installs :program:`stac` as a command-line entrypoint.
To display all the available commands::

    $ stac --help

`stactools-packages <https://github.com/stactools-packages>`_ can extend the command line interface with their own commands via a plugin mechanism.
For example, you can browse a STAC catalog via a local server running `stac-browser <https://github.com/radiantearth/stac-browser>`_ via::

    $ pip install stactools-browse
    $ stac browse catalog.json

See specific ``stactools-package`` documentation for information about what
commands are available.

.. note::

    If you've installed ``stactools`` with AWS S3 support via ``pip install 'stactools[s3]'``, you can enable requester pays via::

        $ AWS_REQUEST_PAYER='requester' stac copy # ...etc...

Full documentation
------------------

.. click:: stactools.cli.cli:cli
   :prog: stac
   :nested: full