System Quickstart

goodmem system quickstart

Set up and test recommended models and a first space

Synopsis

Use one provider API key to create or reuse the console's recommended embedder, LLM, and reranker where available, then create or reuse a first space.

The current GoodMem server, profile, and API key are used. Provider key input is hidden on an interactive terminal. Review the exact models and endpoints, then confirm once. Each available model is tested through GoodMem; provider tests may incur usage charges. Resources created by a run are recorded locally without storing the provider key.

Use retry with the run ID to resume an incomplete setup. Undo removes resources created by that run, including all current memories and chunks in a created space. Reused resources are preserved. Google Application Default Credentials are not supported here; configure those resources with the individual embedder/LLM/reranker commands.

goodmem system quickstart [flags]

Examples

  # Detect the provider from a hidden key prompt, preview, then confirm
  goodmem system quickstart

  # Preview a recipe without credentials, server calls, or a saved run
  goodmem system quickstart --provider openai --dry-run

  # Run without interactive input
  goodmem system quickstart --provider openai --cred-api-key-file provider-key.txt \
    --space-name "Research" --yes --output json

  # Use a piped provider key
  cat provider-key.txt | goodmem system quickstart --provider openai --cred-api-key - --yes

Options

      --cred-api-key string        API key for provider endpoint (use "-" to read from piped stdin)
      --cred-api-key-file string   Read API key from file (file should be mode 0600)
      --cred-api-key-prompt        Prompt for API key interactively (requires TTY, input hidden)
      --cred-gcp                   Use Google Application Default Credentials
      --cred-gcp-quota string      Quota project for Google ADC requests
      --cred-gcp-scope strings     Additional Google ADC OAuth scope (can be specified multiple times)
      --dry-run                    Preview the local recipe without contacting servers or saving a run
  -h, --help                       help for quickstart
      --no-space                   Set up models without a space
  -o, --output string              Output format: table, json (default "table")
      --provider string            Provider override: openai, open-router, gemini, jina, cohere, voyage, dashscope
      --space-name string          Name of the first space (default "My first space")
      --yes                        Confirm the displayed changes without prompting

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 URL (gRPC API; default ports: https=443, http=80)