Skip to main content

strat test

Test the strategy locally. The following environment variables must be set:

  • ALCHEMY_API_KEY : Your Alchemy API key. This will be used to connect with the node provider
  • PRIVATE_KEY_*: Private keys for the EOA wallets. E.g. PRIVATE_KEY_1

Usage​

Usage: almanak strat test [OPTIONS]

Arguments​

Options​

  • working_dir:

    • Type: Path
    • Default: .
    • Usage: --working-dir Working directory containing the strategy files. Defaults to the current directory.

  • preset (REQUIRED):

    • Type: STRING
    • Default: None
    • Usage: --preset Select the strategy preset to test with.

  • local_storage:

    • Type: Path
    • Default: ./local_storage
    • Usage: --local-storage Path to the local storage directory for testing.

  • clean_restart:

    • Type: BOOL
    • Default: False
    • Usage: --clean-restart Clean the local storage and restart the strategy.

  • help:

    • Type: BOOL
    • Default: False
    • Usage: --help Show this message and exit.

CLI Help​

Usage: almanak strat test [OPTIONS]

  Test the strategy locally. The following environment variables must be set:
  - ALCHEMY_API_KEY : Your Alchemy API key. This will be used to connect with
  the node provider - PRIVATE_KEY_*: Private keys for the EOA wallets. E.g.
  PRIVATE_KEY_1

Options:
  --working-dir PATH    Working directory containing the strategy files.
                        Defaults to the current directory.
  --preset TEXT         Select the strategy preset to test with.  [required]
  --local-storage PATH  Path to the local storage directory for testing.
  --clean-restart       Clean the local storage and restart the strategy.
  --help                Show this message and exit.