:tocdepth: 3

:py:mod:`gws.plugin.alkis.cli`
==============================

.. py:module:: gws.plugin.alkis.cli

.. autoapi-nested-parse::

   Command-line ALKIS commands.



**Source code:** :source:`gws.plugin.alkis.cli<gws/plugin/alkis/cli.py>`



Module Contents
---------------



.. py:class:: CreateIndexParams(*args, **kwargs)


   Bases: :py:obj:`gws.CliParams`

   CLI params

   .. py:attribute:: cache
      :type:  bool
      :value: False


      Use object cache.

   .. py:attribute:: force
      :type:  bool
      :value: False


      Force indexing.

   .. py:attribute:: projectUid
      :type:  Optional[str]

      Project uid.


.. py:class:: DumpParams(*args, **kwargs)


   Bases: :py:obj:`gws.CliParams`

   CLI params

   .. py:attribute:: fs
      :type:  str

      Flurstueck UIDs

   .. py:attribute:: path
      :type:  str

      Path to save the dump.

   .. py:attribute:: projectUid
      :type:  Optional[str]

      Project uid.


.. py:class:: ExportParams(*args, **kwargs)


   Bases: :py:obj:`gws.CliParams`

   CLI params

   .. py:attribute:: format
      :type:  str
      :value: 'csv'


      Export format (csv, geojson).

   .. py:attribute:: path
      :type:  str

      Path to save the export.

   .. py:attribute:: projectUid
      :type:  Optional[str]

      Project uid.


.. py:class:: Object


   Bases: :py:obj:`gws.Node`

   GWS object tree node.

   .. py:attribute:: act
      :type:  gws.plugin.alkis.action.Object

   .. py:attribute:: ixStatus
      :type:  gws.plugin.alkis.data.types.IndexStatus

   .. py:method:: do_dump(p: DumpParams)

      Dump internal representations of ALKIS objects.


   .. py:method:: do_export(p: ExportParams)

      Export ALKIS data.


   .. py:method:: do_index(p: CreateIndexParams)

      Create the ALKIS index.


   .. py:method:: do_keys(p: gws.CliParams)

      Print ALKIS export keys.


   .. py:method:: do_status(p: StatusParams)

      Display the status of the ALKIS index.



.. py:class:: StatusParams(*args, **kwargs)


   Bases: :py:obj:`gws.CliParams`

   CLI params

   .. py:attribute:: projectUid
      :type:  Optional[str]

      Project uid.