docs: Chroma source to README.md (#35)

Anush008 · dependabot[bot] · web-flow · commit 7303353626be · 2025-05-19T22:24:39.000+05:30
* refactor: Qdrant to Qdrant impl Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: qdrant.PtrOf Signed-off-by: Anush008 <anushshetty90@gmail.com> * Bump golangci/golangci-lint-action from 7 to 8 (#22) Bumps [golangci/golangci-lint-action](https://github.com/golangci/golangci-lint-action) from 7 to 8. - [Release notes](https://github.com/golangci/golangci-lint-action/releases) - [Commits](golangci/golangci-lint-action@v7...v8) --- updated-dependencies: - dependency-name: golangci/golangci-lint-action dependency-version: '8' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump github.com/grpc-ecosystem/go-grpc-middleware/v2 from 2.3.1 to 2.3.2 (#21) Bumps [github.com/grpc-ecosystem/go-grpc-middleware/v2](https://github.com/grpc-ecosystem/go-grpc-middleware) from 2.3.1 to 2.3.2. - [Release notes](https://github.com/grpc-ecosystem/go-grpc-middleware/releases) - [Commits](grpc-ecosystem/go-grpc-middleware@v2.3.1...v2.3.2) --- updated-dependencies: - dependency-name: github.com/grpc-ecosystem/go-grpc-middleware/v2 dependency-version: 2.3.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore: DRY Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Prettify table Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Nitfix Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: comment Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Don't change M Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Updated commons.go Signed-off-by: Anush008 <anushshetty90@gmail.com> * feat: Milvus Source Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Use nested flags Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: file renamed Signed-off-by: Anush008 <anushshetty90@gmail.com> * test: Milvus source Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Formatting Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Prettify README * docs: CONTRIBUTING.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Update Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: MOre update Signed-off-by: Anush008 <anushshetty90@gmail.com> * Update README.md * chore: Use time.RFC3339 Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Renamed PrepareMigrationOffsetsCollection Signed-off-by: Anush008 <anushshetty90@gmail.com> * DRY Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Use %q to log withing quotes Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Rename to offsetId Signed-off-by: Anush008 <anushshetty90@gmail.com> * Pinecone Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Pinecone source Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Pinecone source to README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Notice Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Lint fixes Signed-off-by: Anush008 <anushshetty90@gmail.com> * Update README.md * chore: Vector names Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Updated README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Updated docstring Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: No index name Signed-off-by: Anush008 <anushshetty90@gmail.com> * refactor: Move flags Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Simplify examples Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: README.md update Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: README.md update Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: Set CreateCollection to true by default Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Updated README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * chore: If ID already a valid UUID, use it directly Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: README.md update Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Chroma to README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * Updated README.dm Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Updated README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Pinecone source to README.md (#32) * docs: Prettify README * docs: CONTRIBUTING.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Update Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: MOre update Signed-off-by: Anush008 <anushshetty90@gmail.com> * Update README.md * docs: Pinecone source to README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Notice Signed-off-by: Anush008 <anushshetty90@gmail.com> * Update README.md * docs: Updated README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Simplify examples Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: README.md update Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: README.md update Signed-off-by: Anush008 <anushshetty90@gmail.com> * docs: Updated README.md Signed-off-by: Anush008 <anushshetty90@gmail.com> --------- Signed-off-by: Anush008 <anushshetty90@gmail.com> --------- Signed-off-by: Anush008 <anushshetty90@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
diff --git a/README.md b/README.md
@@ -7,9 +7,10 @@ CLI tool for migrating data to [Qdrant](http://qdrant.tech) with support for res
 
 ## Supported Sources
 
+* [Chroma](https://trychroma.com/)
 * [Pinecone](https://www.pinecone.io/)
-* [Milvus](https://milvus.io)
-* Another [Qdrant](http://qdrant.tech) instance
+* [Milvus](https://milvus.io/)
+* Another [Qdrant](http://qdrant.tech/) instance
 
 ## Installation
 
@@ -33,6 +34,62 @@ docker pull registry.cloud.qdrant.io/library/qdrant-migration
 
 <details>
 
+<summary><h3>From Chroma</h3></summary>
+
+Migrate data from a **Chroma** database to **Qdrant**:
+
+### 📥 Example
+
+```bash
+migration chroma \
+    --chroma.url=http://localhost:8000
+    --chroma.collection 'collection-name' \
+    --qdrant.url 'https://example.cloud-region.cloud-provider.cloud.qdrant.io:6334' \
+    --qdrant.api-key 'optional-qdrant-api-key' \
+    --qdrant.collection 'target-collection' \
+    --migration.batch-size 64
+````
+
+With Docker:
+
+```bash
+docker run --net=host --rm -it registry.cloud.qdrant.io/library/qdrant-migration chroma \
+    --chroma.url=http://localhost:8000
+    ...
+```
+
+### Chroma Options
+
+| Flag                    | Description                                                              |
+| ----------------------- | ------------------------------------------------------------------------ |
+| `--chroma.collection`   | Chroma collection name.                                                  |
+| `--chroma.url`          | Chroma server URL Default: `"http://localhost:8000"`                     |
+| `--chroma.tenant`       | Chroma tenant. Optional.                                                 |
+| `--chroma.auth-type`    | Authentication type. `"basic"` or `"token"`. Optional.                   |
+| `--chroma.username`     | Username for basic authentication. Optional.                             |
+| `--chroma.password`     | Password for basic authentication. Optional.                             |
+| `--chroma.token`        | Token for token authentication. Optional.                                |
+| `--chroma.token-header` | Token header for authentication. Optional.                               |
+| `--chroma.database`     | Database name. Optional.                                                 |
+
+### Qdrant Options
+
+| Flag                      | Description                                                                                        |
+| ------------------------- | -------------------------------------------------------------------------------------------------- |
+| `--qdrant.collection`     | Target collection name.                                                                            |
+| `--qdrant.url`            | Qdrant gRPC URL. Default: `"http://localhost:6334"`                                                |
+| `--qdrant.api-key`        | Qdrant API key. Optional.                                                                          |
+| `--qdrant.dense-vector`   | Name of the dense vector in Qdrant. Default: `"dense_vector"`                                      |
+| `--qdrant.id-field`       | Field storing Pinecone IDs in Qdrant. Default: `"__id__"`                                          |
+| `--qdrant.distance`       | Distance metric for the Qdrant collection. `"cosine"` or `"dot"` or `"euclid"`. Default: `"euclid"`|
+| `--qdrant.document-field` | Field storing Chroma documents in Qdrant. Default: `"document"`                                    |
+
+* See [Shared Migration Options](#shared-migration-options) for common migration parameters.
+
+</details>
+
+<details>
+
 <summary><h3>From Pinecone</h3></summary>
 
 Migrate data from a **Pinecone** database to **Qdrant**:
@@ -57,7 +114,6 @@ With Docker:
 ```bash
 docker run --net=host --rm -it registry.cloud.qdrant.io/library/qdrant-migration pinecone \
     --pinecone.host 'https://example-index-12345.svc.region.pinecone.io' \
-    --pinecone.api-key 'optional-pinecone-api-key' \
     ...
 ```
 
@@ -73,8 +129,8 @@ docker run --net=host --rm -it registry.cloud.qdrant.io/library/qdrant-migration
 
 | Flag                            | Description                                                     |
 | ------------------------------- | --------------------------------------------------------------- |
-| `--qdrant.url`                  | Qdrant gRPC URL (e.g. `https://your-qdrant-hostname:6334`)      |
 | `--qdrant.collection`           | Target collection name                                          |
+| `--qdrant.url`                  | Qdrant gRPC URL. Default: `"http://localhost:6334"`             |
 | `--qdrant.api-key`              | Qdrant API key                                                  |
 | `--qdrant.dense-vector`         | Name of the dense vector in Qdrant. Default: `"dense_vector"`   |
 | `--qdrant.sparse-vector`        | Name of the sparse vector in Qdrant. Default: `"sparse_vector"` |
@@ -129,7 +185,7 @@ docker run --net=host --rm -it registry.cloud.qdrant.io/library/qdrant-migration
 
 | Flag                            | Description                                                     |
 | ------------------------------- | --------------------------------------------------------------- |
-| `--qdrant.url`                  | Qdrant gRPC URL (e.g. `https://your-qdrant-hostname:6334`)      |
+| `--qdrant.url`                  | Qdrant gRPC URL. Default: `"http://localhost:6334"`             |
 | `--qdrant.collection`           | Target collection name                                          |
 | `--qdrant.api-key`              | Qdrant API key                                                  |
 
@@ -167,16 +223,16 @@ NOTE: If the target collection already exists, its vector size and dimensions mu
 
 | Flag                  | Description                                                |
 | --------------------- | ---------------------------------------------------------- |
-| `--source.url`        | Source gRPC URL (e.g. `https://your-qdrant-hostname:6334`) |
 | `--source.collection` | Source collection name                                     |
+| `--source.url`        | Source gRPC URL. Default: `"http://localhost:6334"`        |
 | `--source.api-key`    | API key for source instance                                |
 
 #### Target Qdrant Options
 
 | Flag                  | Description                                                |
 | --------------------- | ---------------------------------------------------------- |
-| `--target.url`        | Target gRPC URL (e.g. `https://your-qdrant-hostname:6334`) |
 | `--target.collection` | Target collection name                                     |
+| `--target.url`        | Target gRPC URL. Default: `"http://localhost:6334"`        |
 | `--target.api-key`    | API key for target instance                                |
 
 See [Shared Migration Options](#shared-migration-options) for shared parameters.
