mfs-cli 0.4.1

MFS CLI — shell-native client for Multi-source File-like Search
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# mfs — CLI for Multi-source File-like Search

`mfs` is the CLI client for **MFS**: a unified file-like search interface
over codebases, docs, databases and SaaS workspaces. It exposes everything
through familiar shell verbs (`ls`, `cat`, `tree`, `head`, `tail`, `grep`)
plus `mfs search` for hybrid semantic + literal retrieval.

This crate is the binary. The matching server (Python, in the same monorepo)
runs the connectors, ingest pipeline, embedding and retrieval. See the main
project README for the server setup:

**https://github.com/zilliztech/mfs**

## Install

One-line installer (Linux / macOS, x86_64 / arm64):

```bash
curl --proto '=https' --tlsv1.2 -LsSf \
  https://github.com/zilliztech/mfs/releases/latest/download/mfs-cli-installer.sh | sh
```

Or:

```bash
cargo install mfs-cli
```

## Quickstart

Assumes the server is running on `127.0.0.1:13619` (the CLI's default
endpoint). See the main repo for how to start it.

```bash
mfs status                              # server up? connectors registered?
mfs add ./my-repo                       # queue a local directory for indexing
mfs job show JOB_ID                     # wait until status is succeeded

mfs search "rate limit handler" ./my-repo --top-k 5
mfs cat ./my-repo/src/throttle.go --range 42:78
```

`mfs add` returns a queued job id immediately:

```bash
mfs add ./my-repo
mfs job show JOB_ID
```

For the full docs, use:

| Guide | Use it for |
|---|---|
| [Quickstart](../docs/getting-started.md) | First local run and upload-mode choices. |
| [CLI Reference](../docs/cli.md) | Current commands, flags, jobs, connectors, profiles, and JSON output. |
| [Search and Browse](../docs/search-and-browse.md) | Search, locate, and reopen exact evidence. |
| [Connectors](../docs/connectors.md) | Connector catalog, TOML config, credentials, and lifecycle. |
| [Configuration](../docs/configuration.md) | Endpoint, token, profile, and server config precedence. |
| [Deployment](../docs/deployment.md) | Source, Docker, Compose, and beta deployment boundaries. |
| [Troubleshooting](../docs/troubleshooting.md) | Endpoint, auth, upload, indexing, and browse recovery. |

## Pointing at a non-default server

```bash
export MFS_API_URL=http://my-server:13619
mfs status
```

## Status

This is the `v0.4.x` line. The HTTP API may still shift between minor releases.
Track the main repo for changes:

https://github.com/zilliztech/mfs/releases

## License

Apache-2.0.