GoodMem
ReferenceCLI

Space Create

Space Create CLI command reference

goodmem space create

Create a new space

Synopsis

Create a new space in the GoodMem service with the specified name, labels, and settings.

goodmem space create [flags]

Examples

  # Create a basic space with a client-provided ID
  goodmem space create --id "123e4567-e89b-12d3-a456-426614174000" --name "My Project" --embedder-id 123e4567-e89b-12d3-a456-426614174001

  # Create a basic space (server-generated ID)
  goodmem space create --name "My Project" --embedder-id 123e4567-e89b-12d3-a456-426614174000

  # Create a space with multiple embedders and custom weights
  goodmem space create --name "Multi-Model Project" \
    --embedder-id 123e4567-e89b-12d3-a456-426614174000 \
    --embedder-id 987f6543-e21c-65b4-b321-123456789abc \
    --embedder-weight 1.5 \
    --embedder-weight 0.8

  # Create a space with labels
  goodmem space create --name "My Project" --embedder-id 123e4567-e89b-12d3-a456-426614174000 --label user=alice --label project=demo

  # Create a public-readable space
  goodmem space create --name "Public Knowledge Base" --embedder-id 123e4567-e89b-12d3-a456-426614174000 --public-read

  # Create a space for another user (requires admin permissions)
  goodmem space create --name "Team Space" --embedder-id 123e4567-e89b-12d3-a456-426614174000 --owner 123e4567-e89b-12d3-a456-426614174001

  # Create a space with default recursive chunking configuration
  goodmem space create --name "Research Documents" --embedder-id 123e4567-e89b-12d3-a456-426614174000 \
    --chunking recursive --chunk-size 2048 --chunk-overlap 200

  # Create a space with sentence-based chunking for better semantic coherence
  goodmem space create --name "Knowledge Base" --embedder-id 123e4567-e89b-12d3-a456-426614174000 \
    --chunking sentence --max-chunk-size 3000 --language-detection=true

Options

      --chunk-overlap uint32           Overlap between chunks (characters or tokens) (default 64)
      --chunk-size uint32              Maximum chunk size (characters or tokens) (default 512)
      --chunking string                Chunking strategy: none, recursive, sentence (default "recursive")
      --chunking-help                  Show chunking strategies and detailed help
      --embedder-id strings            ID of an embedder to use for this space (can be specified multiple times)
      --embedder-weight float64Slice   Weight for the corresponding embedder during retrieval (defaults to 1.0 if not specified) (default [])
  -h, --help                           help for create
      --id string                      Optional: Client-provided UUID for the space (16 bytes). Server generates if omitted.
      --keep-separator string          Separator retention: none, start, end (default "end")
  -l, --label strings                  Labels in key=value format (can be specified multiple times)
      --length-unit string             Length measurement unit: chars, tokens (default "chars")
      --name string                    Name of the space
      --owner string                   Owner ID for the space (requires admin permissions)
      --public-read                    Whether the space is publicly readable
      --separator strings              Custom separators (defaults: \\n\\n, \\n, space, empty string)
      --separator-regex                Treat separators as regex patterns

Options inherited from parent commands

      --api-key string   API key for authentication (can also be set via GOODMEM_API_KEY environment variable)
      --server string    GoodMem server address (gRPC API) (default "https://localhost:9090")

SEE ALSO