Contents Menu Expand Light mode Dark mode Auto light/dark mode
Jina 2.1.9 documentation
Light Logo Dark Logo

Get started

  • What is Neural Search?
  • Install
  • Run Hello World Demos
    • Fashion image search
    • Covid-19 chatbot
    • Multimodal search

Fundamentals

  • Basic Concepts
  • Document
    • Document
    • DocumentArray
    • DocumentArrayMemmap
  • Executor
    • Create Executor
    • Executor Features
    • Executor in Action
    • Executor File Structure
  • Flow
    • Create Flow
    • Flow IO
    • Add Executor
    • Topology
    • Asynchronous Flow
    • Serving Flow
    • Remarks
  • Clean & Efficient Code

Advanced

  • Share Executors via Hub
    • Hub Portal
    • Create Executor
    • Publish Executor
    • Use Hub Executor
    • Best Practices
  • Remote Executors and Flows via JinaD
    • JinaD Server
    • JinaD Client
    • Remote Executor
    • Workspace
    • Remote Flow
    • Remote Logs
    • JinaD Development Guides
  • Experimental Features
    • Jina on Windows
    • Jina on Kubernetes
    • Indexers on Jina Hub
    • Compound Executors
    • Graph Document

Tutorials

  • Fuzzy grep in 30 Lines
  • Simple Chatbot in Jina
  • Master Executor: from Zero to Hub
  • Use Hub Executors in Hello World
  • Run Executors on GPU

API Reference

  • jina package
    • jina.clients package
      • jina.clients.base package
        • jina.clients.base.grpc module
        • jina.clients.base.helper module
        • jina.clients.base.http module
        • jina.clients.base.websocket module
      • jina.clients.request package
        • jina.clients.request.asyncio module
        • jina.clients.request.helper module
      • jina.clients.grpc module
      • jina.clients.helper module
      • jina.clients.http module
      • jina.clients.mixin module
      • jina.clients.websocket module
    • jina.executors package
      • jina.executors.decorators module
      • jina.executors.metas module
    • jina.flow package
      • jina.flow.asyncio module
      • jina.flow.base module
      • jina.flow.builder module
    • jina.helloworld package
      • jina.helloworld.chatbot package
        • jina.helloworld.chatbot.app module
        • jina.helloworld.chatbot.my_executors module
      • jina.helloworld.fashion package
        • jina.helloworld.fashion.app module
        • jina.helloworld.fashion.helper module
        • jina.helloworld.fashion.my_executors module
      • jina.helloworld.multimodal package
        • jina.helloworld.multimodal.app module
        • jina.helloworld.multimodal.my_executors module
      • jina.helloworld.fork module
    • jina.hubble package
      • jina.hubble.helper module
      • jina.hubble.hubapi module
      • jina.hubble.hubio module
    • jina.jaml package
      • jina.jaml.parsers package
        • jina.jaml.parsers.default package
          • jina.jaml.parsers.default.v1 module
        • jina.jaml.parsers.executor package
          • jina.jaml.parsers.executor.legacy module
        • jina.jaml.parsers.flow package
          • jina.jaml.parsers.flow.legacy module
          • jina.jaml.parsers.flow.v1 module
        • jina.jaml.parsers.base module
      • jina.jaml.helper module
    • jina.logging package
      • jina.logging.formatter module
      • jina.logging.logger module
      • jina.logging.predefined module
      • jina.logging.profile module
    • jina.math package
      • jina.math.dimensionality_reduction module
      • jina.math.distance module
      • jina.math.helper module
    • jina.optimizers package
      • jina.optimizers.discovery module
      • jina.optimizers.flow_runner module
      • jina.optimizers.parameters module
    • jina.parsers package
      • jina.parsers.hubble package
        • jina.parsers.hubble.new module
        • jina.parsers.hubble.pull module
        • jina.parsers.hubble.push module
      • jina.parsers.peapods package
        • jina.parsers.peapods.runtimes package
          • jina.parsers.peapods.runtimes.container module
          • jina.parsers.peapods.runtimes.distributed module
          • jina.parsers.peapods.runtimes.remote module
          • jina.parsers.peapods.runtimes.zed module
          • jina.parsers.peapods.runtimes.zmq module
        • jina.parsers.peapods.base module
        • jina.parsers.peapods.pea module
        • jina.parsers.peapods.pod module
      • jina.parsers.base module
      • jina.parsers.client module
      • jina.parsers.deprecated module
      • jina.parsers.export_api module
      • jina.parsers.flow module
      • jina.parsers.helloworld module
      • jina.parsers.helper module
      • jina.parsers.optimizer module
      • jina.parsers.ping module
    • jina.peapods package
      • jina.peapods.grpc package
      • jina.peapods.peas package
        • jina.peapods.peas.helper module
      • jina.peapods.pods package
        • jina.peapods.pods.k8slib package
          • jina.peapods.pods.k8slib.kubernetes_client module
          • jina.peapods.pods.k8slib.kubernetes_deployment module
          • jina.peapods.pods.k8slib.kubernetes_tools module
        • jina.peapods.pods.compound module
        • jina.peapods.pods.factory module
        • jina.peapods.pods.k8s module
      • jina.peapods.runtimes package
        • jina.peapods.runtimes.container package
          • jina.peapods.runtimes.container.helper module
        • jina.peapods.runtimes.gateway package
          • jina.peapods.runtimes.gateway.grpc package
          • jina.peapods.runtimes.gateway.http package
            • jina.peapods.runtimes.gateway.http.app module
            • jina.peapods.runtimes.gateway.http.models module
          • jina.peapods.runtimes.gateway.websocket package
            • jina.peapods.runtimes.gateway.websocket.app module
        • jina.peapods.runtimes.grpc package
        • jina.peapods.runtimes.jinad package
        • jina.peapods.runtimes.request_handlers package
          • jina.peapods.runtimes.request_handlers.data_request_handler module
        • jina.peapods.runtimes.zmq package
          • jina.peapods.runtimes.zmq.asyncio module
          • jina.peapods.runtimes.zmq.zed module
        • jina.peapods.runtimes.base module
      • jina.peapods.stream package
        • jina.peapods.stream.base module
        • jina.peapods.stream.client module
        • jina.peapods.stream.gateway module
        • jina.peapods.stream.helper module
      • jina.peapods.zmq package
      • jina.peapods.networking module
    • jina.proto package
      • jina.proto.jina_pb2 module
      • jina.proto.jina_pb2_grpc module
      • jina.proto.serializer module
    • jina.schemas package
      • jina.schemas.executor module
      • jina.schemas.flow module
      • jina.schemas.helper module
      • jina.schemas.meta module
      • jina.schemas.pod module
    • jina.types package
      • jina.types.arrays package
        • jina.types.arrays.abstract module
        • jina.types.arrays.bpm module
        • jina.types.arrays.chunk module
        • jina.types.arrays.document module
        • jina.types.arrays.match module
        • jina.types.arrays.memmap module
        • jina.types.arrays.neural_ops module
        • jina.types.arrays.search_ops module
        • jina.types.arrays.traversable module
      • jina.types.document package
        • jina.types.document.converters module
        • jina.types.document.generators module
        • jina.types.document.graph module
        • jina.types.document.helper module
      • jina.types.message package
        • jina.types.message.common module
      • jina.types.ndarray package
        • jina.types.ndarray.dense package
          • jina.types.ndarray.dense.numpy module
        • jina.types.ndarray.sparse package
          • jina.types.ndarray.sparse.numpy module
          • jina.types.ndarray.sparse.pytorch module
          • jina.types.ndarray.sparse.scipy module
          • jina.types.ndarray.sparse.tensorflow module
        • jina.types.ndarray.generic module
      • jina.types.request package
        • jina.types.request.control module
        • jina.types.request.data module
        • jina.types.request.mixin module
      • jina.types.routing package
        • jina.types.routing.table module
      • jina.types.score package
        • jina.types.score.map module
      • jina.types.list module
      • jina.types.mixin module
      • jina.types.struct module
    • jina.checker module
    • jina.enums module
    • jina.excepts module
    • jina.helper module
    • jina.importer module
  • Jina Command-Line Interface
  • Jina Protobuf Specification
    • Protocol Documentation

Link

  • Jina Hub
  • Benchmark

cli package¶

Submodules¶

  • cli.api module
  • cli.autocomplete module
  • cli.export module
  • cli.lookup module

Module contents¶

cli.main()[source]¶

The main entrypoint of the CLI

Copyright © Jina AI Limited. All rights reserved. Last updated on Oct 19, 2021.
Contents
  • cli package
    • Submodules
    • Module contents
  Ask our docs!

You can ask questions about our docs. Try:

  • Does Jina support Kubernetes?

  • How can I traverse a nested DocumentArray?

  • What are the basic concepts in Jina?

${qa.question}

${qa.answer.text}

Report
Source