# Milvus_CLI🚀
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/zilliztech/milvus_cli?include_prereleases) ![PyPI](https://img.shields.io/pypi/v/milvus-cli)
![PyPI - Downloads](https://img.shields.io/pypi/dm/milvus_cli?label=PYPI%20downloads) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/downloads-pre/zilliztech/milvus_cli/latest/total?label=Release%40latest%20downloads) ![Docker Pulls](https://img.shields.io/docker/pulls/zilliz/milvus_cli)
![GitHub repo size](https://img.shields.io/github/repo-size/zilliztech/milvus_cli) ![PyPI - License](https://img.shields.io/pypi/l/milvus-cli)
## Overview
[Milvus](https://github.com/milvus-io/milvus) Command Line Interface based on [Milvus Python SDK](https://github.com/milvus-io/pymilvus).
- 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
## Installation methods
### 🔝Install in a Python environment
#### Prerequisites
Python >= 3.8.5
#### Install from PyPI (Recommended)
Run `pip install pymilvus>=2.4.3`
Run `pip install milvus-cli==1.0.1`
#### Install from a tarball
1. Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) 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 .`
### Install from an executable file
#### Windows .exe file
Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of `milvus_cli.exe` and run it.
#### Ubuntu executable file
1. Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of `milvus_cli-<version>-Linux`.
2. Run `sudo chmod +x milvus_cli-<version>-Linux` to allow executing `milvus_cli-<version>-Linux` as program.
3. Run `./milvus_cli-<version>-Linux`.
#### MacOS executable file
1. Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of `milvus_cli-<version>-macOS`.
2. Run `sudo chmod +x milvus_cli-<version>-macOS` to allow executing `milvus_cli-<version>-macOS` as program.
3. Run `./milvus_cli-<version>-macOS`.
### 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`.
- In a Windows environment, double click `milvus_cli-<version>.exe`.
- In an Ubuntu environment, run `./milvus_cli-<version>-Linux`.
- In a MacOS environment, run `./milvus_cli-<version>-macOS`.
### Document
https://milvus.io/docs/cli_commands.md
## 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](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ)!
<a href="https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ">
<img src="https://assets.zilliz.com/readme_slack_4a07c4c92f.png" alt="Miluvs Slack Channel" height="150" width="500">
</a>
<br><!-- Do not remove start of hero-bot --><br>
<img src="https://img.shields.io/badge/all--contributors-6-orange"><br>
<a href="https://github.com/chris-zilliz"><img src="https://avatars.githubusercontent.com/u/91247127?v=4" width="30px" /></a>
<a href="https://github.com/czhen-zilliz"><img src="https://avatars.githubusercontent.com/u/83751452?v=4" width="30px" /></a>
<a href="https://github.com/haorenfsa"><img src="https://avatars.githubusercontent.com/u/15938850?v=4" width="30px" /></a>
<a href="https://github.com/kateshaowanjou"><img src="https://avatars.githubusercontent.com/u/58837504?v=4" width="30px" /></a>
<a href="https://github.com/matrixji"><img src="https://avatars.githubusercontent.com/u/183388?v=4" width="30px" /></a>
<a href="https://github.com/sre-ci-robot"><img src="https://avatars.githubusercontent.com/u/56469371?v=4" width="30px" /></a>
<br><!-- Do not remove end of hero-bot --><br>
Raw data
{
"_id": null,
"home_page": "https://github.com/zilliztech/milvus_cli",
"name": "milvus-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Milvus Team",
"author_email": "milvus-team@zilliz.com",
"download_url": "https://files.pythonhosted.org/packages/0d/cc/5ced83dced0146fca5d35518bc55e5f5541b4b23a9212afbdb001080da6a/milvus_cli-1.0.1.tar.gz",
"platform": null,
"description": "# Milvus_CLI\ud83d\ude80\n\n![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/zilliztech/milvus_cli?include_prereleases) ![PyPI](https://img.shields.io/pypi/v/milvus-cli)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/milvus_cli?label=PYPI%20downloads) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/downloads-pre/zilliztech/milvus_cli/latest/total?label=Release%40latest%20downloads) ![Docker Pulls](https://img.shields.io/docker/pulls/zilliz/milvus_cli)\n![GitHub repo size](https://img.shields.io/github/repo-size/zilliztech/milvus_cli) ![PyPI - License](https://img.shields.io/pypi/l/milvus-cli)\n\n## Overview\n\n[Milvus](https://github.com/milvus-io/milvus) Command Line Interface based on [Milvus Python SDK](https://github.com/milvus-io/pymilvus).\n\n- Applicable to most platforms: MS Windows, macOS, Ubuntu\n\n- Support pip install & offline installation package\n\n- Support single executable file\n\n- Milvus Python SDK full function coverage\n\n- Built-in help function\n\n- Support auto completion\n\n## Installation methods\n\n### \ud83d\udd1dInstall in a Python environment\n\n#### Prerequisites\n\nPython >= 3.8.5\n\n#### Install from PyPI (Recommended)\n\nRun `pip install pymilvus>=2.4.3`\nRun `pip install milvus-cli==1.0.1`\n\n#### Install from a tarball\n\n1. Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of ` milvus_cli-<version>.tar.gz`.\n2. Run `pip install milvus_cli-<version>.tar.gz`.\n\n#### Install from source code\n\n1. Run `git clone https://github.com/zilliztech/milvus_cli.git`.\n2. Run `cd milvus_cli`.\n3. Run `pip install --editable .`\n\n### Install from an executable file\n\n#### Windows .exe file\n\nDownload the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of `milvus_cli.exe` and run it.\n\n#### Ubuntu executable file\n\n1. Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of `milvus_cli-<version>-Linux`.\n2. Run `sudo chmod +x milvus_cli-<version>-Linux` to allow executing `milvus_cli-<version>-Linux` as program.\n3. Run `./milvus_cli-<version>-Linux`.\n\n#### MacOS executable file\n\n1. Download the [latest release](https://github.com/zilliztech/milvus_cli/releases/latest) of `milvus_cli-<version>-macOS`.\n2. Run `sudo chmod +x milvus_cli-<version>-macOS` to allow executing `milvus_cli-<version>-macOS` as program.\n3. Run `./milvus_cli-<version>-macOS`.\n\n### Docker image in docker hub\n\n`docker run -it zilliz/milvus_cli:latest`\n\n## Usage\n\nRun `milvus_cli` (in a Python environment) or double click `milvus_cli-<version>.exe` file (in a Windows environment).\n\n#### Run Milvus_CLI\n\n- In a Python environment, run `milvus_cli`.\n- In a Windows environment, double click `milvus_cli-<version>.exe`.\n- In an Ubuntu environment, run `./milvus_cli-<version>-Linux`.\n- In a MacOS environment, run `./milvus_cli-<version>-macOS`.\n\n### Document\n\nhttps://milvus.io/docs/cli_commands.md\n\n## Community\n\n\ud83d\udcac Community isn\u2019t just about writing code together. Come join the conversation, share your knowledge and get your questions answered on [Milvus Slack Channel](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ)!\n\n<a href=\"https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ\">\n <img src=\"https://assets.zilliz.com/readme_slack_4a07c4c92f.png\" alt=\"Miluvs Slack Channel\" height=\"150\" width=\"500\">\n</a>\n\n<br><!-- Do not remove start of hero-bot --><br>\n<img src=\"https://img.shields.io/badge/all--contributors-6-orange\"><br>\n<a href=\"https://github.com/chris-zilliz\"><img src=\"https://avatars.githubusercontent.com/u/91247127?v=4\" width=\"30px\" /></a>\n<a href=\"https://github.com/czhen-zilliz\"><img src=\"https://avatars.githubusercontent.com/u/83751452?v=4\" width=\"30px\" /></a>\n<a href=\"https://github.com/haorenfsa\"><img src=\"https://avatars.githubusercontent.com/u/15938850?v=4\" width=\"30px\" /></a>\n<a href=\"https://github.com/kateshaowanjou\"><img src=\"https://avatars.githubusercontent.com/u/58837504?v=4\" width=\"30px\" /></a>\n<a href=\"https://github.com/matrixji\"><img src=\"https://avatars.githubusercontent.com/u/183388?v=4\" width=\"30px\" /></a>\n<a href=\"https://github.com/sre-ci-robot\"><img src=\"https://avatars.githubusercontent.com/u/56469371?v=4\" width=\"30px\" /></a>\n<br><!-- Do not remove end of hero-bot --><br>\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CLI for Milvus",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/zilliztech/milvus_cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "440feb45411cc966100ffd3eae543ae499cb88ba5d6b0aa6d7ee93f27e16917b",
"md5": "6923b2e350265151c36c41d30a6d13fd",
"sha256": "c9b6417d16ae4c8aa25b2c5c38de6e2d695f4b89fc7b8ff5d14858e4c775094b"
},
"downloads": -1,
"filename": "milvus_cli-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6923b2e350265151c36c41d30a6d13fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 53006,
"upload_time": "2024-12-17T11:12:32",
"upload_time_iso_8601": "2024-12-17T11:12:32.659782Z",
"url": "https://files.pythonhosted.org/packages/44/0f/eb45411cc966100ffd3eae543ae499cb88ba5d6b0aa6d7ee93f27e16917b/milvus_cli-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0dcc5ced83dced0146fca5d35518bc55e5f5541b4b23a9212afbdb001080da6a",
"md5": "59ed30209222a07f515eeb5aac2dd1f9",
"sha256": "dd619a3b9fe8990b1672132f2704a3fa6fe3a92a4c133ebbe2af12be5db760c1"
},
"downloads": -1,
"filename": "milvus_cli-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "59ed30209222a07f515eeb5aac2dd1f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 40158,
"upload_time": "2024-12-17T11:12:35",
"upload_time_iso_8601": "2024-12-17T11:12:35.144407Z",
"url": "https://files.pythonhosted.org/packages/0d/cc/5ced83dced0146fca5d35518bc55e5f5541b4b23a9212afbdb001080da6a/milvus_cli-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 11:12:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zilliztech",
"github_project": "milvus_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "milvus-cli"
}