Milvus_CLI🚀

Overview

Milvus Command Line Interface based on Milvus Python SDK.

• Applicable to most platforms: MS Windows, macOS, Ubuntu

• Support pip install & offline installation package

• Support single executable file

• Milvus Python SDK full function coverage

• Built-in help function

• Support auto completion

Project Structure

milvus_cli/
├── Core Modules
│   ├── main.py          # Main entry point
│   ├── Cli.py           # CLI command interface
│   ├── BaseClient.py    # Base class for all client modules
│   ├── ConnectionClient.py # Milvus connection management
│   ├── CollectionClient.py # Collection operations
│   ├── DatabaseClient.py   # Database management
│   ├── IndexClient.py      # Index management
│   ├── PartitionClient.py  # Partition management
│   ├── DataClient.py       # Data import/export/search
│   ├── RoleClient.py       # Role management
│   ├── UserClient.py       # User management
│   ├── AliasClient.py      # Alias management
│   ├── ResourceGroup.py    # Resource group management
│   ├── PrivilegeGroup.py   # Privilege group management
│   ├── CliClient.py        # Main CLI client (aggregates all modules)
│   ├── OutputFormatter.py  # Output formatting (table/json/csv)
│   ├── Fs.py               # File system operations
│   ├── Types.py            # Data type definitions
│   ├── utils.py            # Utility functions
│   └── Validation.py       # Input validation
├── scripts/             # CLI command implementations
│   ├── milvus_cli.py    # Main CLI script
│   ├── init_client_cli.py # CLI initialization and global state
│   ├── helper_client_cli.py # REPL loop, command groups, output settings
│   ├── helper_cli.py    # Help, version, history commands
│   ├── connection_client_cli.py # Connection commands
│   ├── collection_client_cli.py # Collection commands
│   ├── database_client_cli.py  # Database commands
│   ├── index_client_cli.py     # Index commands
│   ├── partition_client_cli.py # Partition commands
│   ├── data_client_cli.py      # Data commands
│   ├── role_client_cli.py      # Role commands
│   ├── user_client_cli.py      # User commands
│   ├── alias_client_cli.py     # Alias commands
│   ├── resource_group_cli.py   # Resource group commands
│   └── privilege_group_cli.py  # Privilege group commands
├── test/                # Unit tests (internal APIs)
│   ├── test_config.py
│   ├── test_connection_client.py
│   ├── test_collection_client.py
│   └── ...
└── tests/               # Integration tests (CLI commands)
    ├── conftest.py
    ├── test_connection.py
    ├── test_collection.py
    └── ...

Core Components

• Core Modules: Implement the main functionality logic of Milvus CLI, each module handles specific Milvus feature domains
• scripts/: Contains all CLI command implementations, providing user interaction interfaces
• milvus_cli/test/: Unit tests for internal Python modules and classes
• tests/: Integration tests for CLI commands and user interface

Installation methods

🔝Install in a Python environment

Prerequisites

Python >= 3.8.5

Install from PyPI (Recommended)

Run pip install pymilvus>=2.5.0 Run pip install milvus-cli==1.0.2

Install from a tarball

1. Download the latest release of milvus_cli-<version>.tar.gz.
2. Run pip install milvus_cli-<version>.tar.gz.

Install from source code

1. Run git clone https://github.com/zilliztech/milvus_cli.git.
2. Run cd milvus_cli.
3. Run pip install --editable .

Docker image in docker hub

docker run -it zilliz/milvus_cli:latest

Usage

Run milvus_cli (in a Python environment) or double click milvus_cli-<version>.exe file (in a Windows environment).

Run Milvus_CLI

• In a Python environment, run milvus_cli.

Document

https://milvus.io/docs/cli_commands.md

Testing

This project has two types of tests:

Integration Tests (CLI Commands)

Test the command-line interface and user experience.

# Run all integration tests
source venv/bin/activate
python run_tests.py --uri http://localhost:19530

# Or use pytest directly
MILVUS_URI=http://localhost:19530 pytest tests/ -v

See TESTING.md for detailed guide.

Unit Tests (Internal APIs)

Test Python modules and classes directly.

# Run all unit tests
python -m unittest discover milvus_cli/test

# Run specific test
python -m unittest milvus_cli.test.test_connection_client

See milvus_cli/test/README.md for configuration details.

Community

💬 Community isn’t just about writing code together. Come join the conversation, share your knowledge and get your questions answered on Milvus Slack Channel!