Skip to content

Commit de1bfc0

Browse files
add zilliz-cli.md
Signed-off-by: AnthonyTsu1984 <wenjia.tu@zilliz.com>
1 parent fdffea4 commit de1bfc0

1 file changed

Lines changed: 90 additions & 0 deletions

File tree

reference/cli/cli/zilliz-cli.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
displayed_sidebar: cliSidebar
3+
sidebar_label: Overview
4+
slug: /cli/overview
5+
beta: FALSE
6+
notebook: FALSE
7+
sidebar_position: 0
8+
---
9+
10+
import Admonition from '@theme/Admonition';
11+
import Tabs from '@theme/Tabs';
12+
import TabItem from '@theme/TabItem';
13+
14+
15+
# Zilliz CLI Reference
16+
17+
The Zilliz Command Line Interface () provides a command-line tool for managing your Zilliz Cloud resources and performing data operations.
18+
19+
## Features
20+
21+
- **Cloud Management** - Manage clusters, projects, volumes, and backups
22+
- **Configuration** - Configure authentication, alerts, and CLI settings
23+
- **Data Operations** - Manage collections, databases, indexes, and perform vector searches
24+
25+
## Quick Start
26+
27+
### Install
28+
29+
<Tabs groupId="cli-install" defaultValue='linux' values={[{"label":"macOS / Linux","value":"linux"},{"label":"Windows","value":"windows"}]}>
30+
<TabItem value="linux">
31+
32+
```bash
33+
curl -fsSL https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.sh | bash
34+
```
35+
36+
</TabItem>
37+
<TabItem value="windows">
38+
39+
```bash
40+
irm https://raw.githubusercontent.com/zilliztech/zilliz-cli/master/install.ps1 | iex
41+
```
42+
43+
</TabItem>
44+
</Tabs>
45+
46+
### Authenticate
47+
48+
```bash
49+
zilliz login
50+
```
51+
52+
### Create a Cluster
53+
54+
```bash
55+
zilliz cluster create --name my-cluster --type serverless
56+
```
57+
58+
## Command Categories
59+
60+
### Cloud Management
61+
- [Backup](/reference/cli/CloudManagement-Backup) - Create, restore, and manage backups
62+
- [Cluster](/reference/cli/CloudManagement-Cluster) - Create, suspend, resume, and delete clusters
63+
- [Import](/reference/cli/CloudManagement-Cluster) - Import data
64+
- [Job](/reference/cli/CloudManagement-Job) - Manage jobs
65+
- [Project](/reference/cli/CloudManagement-Project) - Manage projects
66+
- [Volume](/reference/cli/CloudManagement-Volume) - Manage storage volumes
67+
68+
### Configuration
69+
- [Auth](/reference/cli/Configuration-Auth) - Login, logout, and switch accounts
70+
- [Configure](/reference/cli/Configuration-Configure) - Set and get configuration values
71+
- [Context](/reference/cli/Configuration-Context) - Manage CLI contexts
72+
- [Alert](/reference/cli/Configuration-Alert) - Create and manage alerts
73+
- [Completion](/reference/cli/Configuration-Completion) - Shell completion setup
74+
75+
### Data Operations
76+
- [Collection](/reference/cli/DataOperations-Collection) - Create, describe, and manage collections
77+
- [Database](/reference/cli/DataOperations-Database) - Manage databases
78+
- [Index](/reference/cli/DataOperations-Index) - Create and manage indexes
79+
- [Partition](/reference/cli/DataOperations-Partition) - Create and manage partitions
80+
- [Role](/reference/cli/DataOperations-Role)
81+
- [User](/reference/cli/DataOperations-User) - Manage users
82+
- [Vector](/reference/cli/DataOperations-Vector) - Insert, search, and query vectors
83+
84+
85+
86+
## Get Started
87+
88+
- [Authenticate](/reference/cli/cli/Auth-login)
89+
- [Create a Cluster](/reference/cli/cli/Cluster-create)
90+
- [Create a Collection](/reference/cli/cli/Collection-create)

0 commit comments

Comments
 (0)