ReMe/docs/Installation.md

1.6 KiB

Installing MemoryScope

  1. Clone the repository and edit settings

    # clone project
    git clone https://...
    cd memoryscope
    # edit configuration, e.g. add api keys
    vim memoryscope/core/config/demo_config.yaml
    
  2. Build Docker image

    sudo docker build --network=host -t memoryscope .
    
  3. Launch Docker container

    sudo docker run -it --rm --net=host memoryscope
    
  1. Clone the repository and edit settings

    # clone project
    git clone https://...
    cd memoryscope
    # edit configuration, e.g. add api keys
    vim memoryscope/core/config/demo_config.yaml
    
  2. Edit docker-compose.yml to change environment variable.

    DASHSCOPE_API_KEY: "sk-0000000000"
    
  3. Run docker-compose up to build and launch the memory-scope cli interface.

III. Install in native system [Linux only]

  1. Clone the repository and edit settings

    # clone project
    git clone https://...
    cd memoryscope
    # edit configuration, e.g. add api keys
    vim memoryscope/core/config/demo_config.yaml
    
  2. Install

    poetry install
    
  3. Run Elasticsearch service, refer to elasticsearch documents.

  4. Launch memoryscope, also refer to cli documents

    memoryscope --config_path=memoryscope/core/config/demo_config.yaml