# Doc Store Manage document store in sfp server * [`sfp server doc-store add`](#sfp-server-doc-store-add) * [`sfp server doc-store collection add`](#sfp-server-doc-store-collection-add) * [`sfp server doc-store collection delete`](#sfp-server-doc-store-collection-delete) * [`sfp server doc-store collection get`](#sfp-server-doc-store-collection-get) * [`sfp server doc-store collection list`](#sfp-server-doc-store-collection-list) * [`sfp server doc-store collection update`](#sfp-server-doc-store-collection-update) * [`sfp server doc-store delete`](#sfp-server-doc-store-delete) * [`sfp server doc-store get`](#sfp-server-doc-store-get) * [`sfp server doc-store update`](#sfp-server-doc-store-update) ## `sfp server doc-store add` Add a document to the doc store ``` USAGE $ sfp server doc-store add -k [--json] [--repository ] [-e ] [-t ] [--sfp-server-url ] [-v | -f ] FLAGS -e, --email= [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if --application-token is provided. -f, --file= Path to JSON file containing the value -k, --key= (required) Key for the document -t, --application-token= [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence over --email. -v, --value= Value for the document (must be valid JSON) --repository= The repository identifier. E.g `owner/repo` --sfp-server-url= [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable `SFP_SERVER_URL` or config: sfp config:set server-url GLOBAL FLAGS --json Format output as json. DESCRIPTION Add a document to the doc store EXAMPLES $ sfp server doc-store add --key myKey --value '{"data": "value"}' --email user@example.com $ sfp server doc-store add --key myKey --value '{"data": "value"}' --application-token myToken $ sfp server doc-store add --key myKey --file ./data.json --email user@example.com ``` *See code:* [*src/commands/server/doc-store/add.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store collection add` Add a document to a collection in the doc store ``` USAGE $ sfp server doc-store collection add -c (-k | -d ) [--json] [--repository ] [-e ] [-t ] [--sfp-server-url ] [-v | -f | ] FLAGS -c, --collection= (required) Name of the collection -d, --folder= Path to folder to process recursively -e, --email= [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if --application-token is provided. -f, --file= Path to JSON file containing the value -k, --key= (required) Key for the document -t, --application-token= [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence over --email. -v, --value= Value for the document (must be valid JSON) --repository= The repository identifier. E.g `owner/repo` --sfp-server-url= [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable `SFP_SERVER_URL` or config: sfp config:set server-url GLOBAL FLAGS --json Format output as json. DESCRIPTION Add a document to a collection in the doc store EXAMPLES $ sfp server doc-store collection add --collection myCollection --key myKey --value '{"data": "value"}' --email user@example.com $ sfp server doc-store collection add --collection myCollection --key myKey --value '{"data": "value"}' --application-token myToken $ sfp server doc-store collection add --collection myCollection --key myKey --file ./data.json --email user@example.com $ sfp server doc-store collection add --collection myCollection --folder ./data --email user@example.com ``` *See code:* [*src/commands/server/doc-store/collection/add.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store collection delete` Delete a document from a collection in the doc store ``` USAGE $ sfp server doc-store collection delete -c [--json] [-k | -m ] [-n ] FLAGS -c, --collection= (required) Name of the collection -k, --key= Key of the document to delete -m, --keys= Comma-separated list of document keys to delete -n, --version= Version of the document to delete GLOBAL FLAGS --json Format output as json. DESCRIPTION Delete a document from a collection in the doc store EXAMPLES $ sfp server doc-store collection delete --collection myCollection --key myKey --version 1 --email user@example.com $ sfp server doc-store collection delete --collection myCollection --key myKey --version 1 --application-token myToken $ sfp server doc-store collection delete --collection myCollection --keys key1,key2,key3 --version 1 --email user@example.com ``` *See code:* [*src/commands/server/doc-store/collection/delete.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store collection get` Get documents from a collection in the doc store ``` USAGE $ sfp server doc-store collection get -c [--json] [-k | -o | -f ...] [-s ...] [--limit ] [--offset ] [-e | -t ] [--sfp-server-url ] FLAGS -c, --collection= (required) Name of the collection -e, --email= Email used for authentication -f, --filter=... Filter documents using expressions like 'field=value', 'field>value', 'field~pattern' -k, --key= Key of the document to retrieve -o, --output-folder= Output folder path to recreate the collection structure -s, --sort=... Sort results by field:direction (e.g., 'createdAt:desc') -t, --application-token= Application token for authentication --limit= [default: 100] Maximum number of results to return (default: 100) --offset= Number of results to skip for pagination (default: 0) --sfp-server-url= [default: http://localhost:3029, env: SFP_SERVER_URL] URL of the SFP server GLOBAL FLAGS --json Format output as json. DESCRIPTION Get documents from a collection in the doc store EXAMPLES $ sfp server doc-store collection get --collection myCollection --key myKey --email user@example.com $ sfp server doc-store collection get --collection myCollection --key myKey --application-token myToken $ sfp server doc-store collection get --collection myCollection --output-folder ./output --email user@example.com $ sfp server doc-store collection get --collection myCollection --output-folder ./output --application-token myToken # Filter by status $ sfp server doc-store collection get -c builds --filter "status=completed" --email user@example.com # Multiple filters with sorting $ sfp server doc-store collection get -c packages \ --filter "status=active" \ --filter "version>2.0" \ --sort "createdAt:desc" \ --limit 10 \ --email user@example.com # Pattern matching $ sfp server doc-store collection get -c releases --filter "name~core" --email user@example.com # In operator for multiple values $ sfp server doc-store collection get -c deployments --filter "env in(dev,staging,prod)" --email user@example.com ``` *See code:* [*src/commands/server/doc-store/collection/get.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store collection list` List all doc store collections on the server ``` USAGE $ sfp server doc-store collection list [--json] [-e | -t ] [--sfp-server-url ] FLAGS -e, --email= Email of the user -t, --application-token= Application token for authentication --sfp-server-url= [default: http://localhost:3029, env: SFP_SERVER_URL] URL of the sfp server GLOBAL FLAGS --json Format output as json. DESCRIPTION List all doc store collections on the server EXAMPLES $ sfp server doc-store collection list --email user@example.com $ sfp server doc-store collection list --application-token myToken $ sfp server doc-store collection list --email user@example.com --json ``` *See code:* [*src/commands/server/doc-store/collection/list.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store collection update` Update a document in a collection in the doc store ``` USAGE $ sfp server doc-store collection update -c [--json] [--repository ] [-e ] [-t ] [--sfp-server-url ] [-k | -d ] [-v | -f | ] [-n ] [-u] FLAGS -c, --collection= (required) Name of the collection -d, --folder= Path to folder to process recursively -e, --email= [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if --application-token is provided. -f, --file= Path to JSON file containing the value -k, --key= Key of the document to update -n, --current-version= Version of the document to update -t, --application-token= [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence over --email. -u, --upsert Create document if it does not exist, otherwise update it -v, --value= New value for the document (must be valid JSON) --repository= The repository identifier. E.g `owner/repo` --sfp-server-url= [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable `SFP_SERVER_URL` or config: sfp config:set server-url GLOBAL FLAGS --json Format output as json. DESCRIPTION Update a document in a collection in the doc store EXAMPLES $ sfp server doc-store collection update --collection myCollection --key myKey --value '{"data": "value"}' --current-version 1 --email user@example.com $ sfp server doc-store collection update --collection myCollection --key myKey --value '{"data": "value"}' --current-version 1 --application-token myToken $ sfp server doc-store collection update --collection myCollection --key myKey --file ./data.json --current-version 1 --email user@example.com $ sfp server doc-store collection update --collection myCollection --folder ./data --current-version 1 --email user@example.com ``` *See code:* [*src/commands/server/doc-store/collection/update.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store delete` Delete a document from the doc store ``` USAGE $ sfp server doc-store delete -k [--json] [--repository ] [-e ] [-t ] [--sfp-server-url ] [-n ] FLAGS -e, --email= [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if --application-token is provided. -k, --key= (required) Key of the document to delete -n, --version= Version of the document to delete -t, --application-token= [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence over --email. --repository= The repository identifier. E.g `owner/repo` --sfp-server-url= [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable `SFP_SERVER_URL` or config: sfp config:set server-url GLOBAL FLAGS --json Format output as json. DESCRIPTION Delete a document from the doc store EXAMPLES $ sfp server doc-store delete --key myKey --email user@example.com $ sfp server doc-store delete --key myKey --application-token myToken ``` *See code:* [*src/commands/server/doc-store/delete.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store get` Get a document from the doc store ``` USAGE $ sfp server doc-store get -k [--json] [--repository ] [-e ] [-t ] [--sfp-server-url ] FLAGS -e, --email= [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if --application-token is provided. -k, --key= (required) Key of the document to retrieve -t, --application-token= [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence over --email. --repository= The repository identifier. E.g `owner/repo` --sfp-server-url= [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable `SFP_SERVER_URL` or config: sfp config:set server-url GLOBAL FLAGS --json Format output as json. DESCRIPTION Get a document from the doc store EXAMPLES $ sfp server doc-store get --key myKey --email user@example.com $ sfp server doc-store get --key myKey --application-token myToken ``` *See code:* [*src/commands/server/doc-store/get.ts*](https://source.flxbl.io/flxbl/sfp-pro) ## `sfp server doc-store update` Update a document in the doc store ``` USAGE $ sfp server doc-store update -k [--json] [--repository ] [-e ] [-t ] [--sfp-server-url ] [-v | -f ] [-n ] [-u] FLAGS -e, --email= [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if --application-token is provided. -f, --file= Path to file to upload. JSON files will be parsed, other files will be base64 encoded -k, --key= (required) Key of the document to update -n, --current-version= Version of the document to update -t, --application-token= [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence over --email. -u, --upsert Create document if it does not exist, otherwise update it -v, --value= New value for the document (must be valid JSON) --repository= The repository identifier. E.g `owner/repo` --sfp-server-url= [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable `SFP_SERVER_URL` or config: sfp config:set server-url GLOBAL FLAGS --json Format output as json. DESCRIPTION Update a document in the doc store EXAMPLES $ sfp server doc-store update --key myKey --value '{"data": "value"}' --current-version 1 --email user@example.com $ sfp server doc-store update --key myKey --value '{"data": "value"}' --current-version 1 --application-token myToken $ sfp server doc-store update --key myKey --file ./data.json --current-version 1 --email user@example.com $ sfp server doc-store update --key myKey --file ./image.png --upsert --email user@example.com ``` *See code:* [*src/commands/server/doc-store/update.ts*](https://source.flxbl.io/flxbl/sfp-pro) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.flxbl.io/flxbl/sfp/cli-reference-v50-and-below/server/doc-store.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.