Theatre

The Theatre is a totally self contained environment that runs all your skills. It also handles operations that span multiple skills, like boot or upgrade.

In a technical sense, it’s a monorepo that contains all your skills that uses pm2 to runs each skill. It relies on a bunch of bash scripts to do a lot of the heavy lifting.

The Sprucebot Theatre you downloaded as part of the onboarding is an Electron app that points to the local Theatre installed at ~/.spruce/theatre-monorepo.

When you open the Sprucebot Theatre app, it actually executes the following commands behind-the-scenes:

cd ~/.spruce/theatre-monorepo 
yarn boot

And when you shutdown the app, it runs:

cd ~/.spruce/theatre-monorepo
yarn shutdown

Theatre Commands

Note: If you are working with the Theatre directly, you use yarn to execute scripts. The SpruceCLI is used when working with individual Skills.

If you are working directly with the Theatre in your favorite terminal app, you have the following commands available:

*Note: Many commands support --help so you can see the options available. Note: After making any changes to the blueprint.yml, you should run yarn setup.theatre blueprint.yml again to ensure the changes are propagated.

Blueprint.yml

Here is an example of a blueprint.yml file that you may edit to suit your needs:

skills:
  - git@github.com:sprucelabsai/spruce-theme-skill.git

admin:
  - PHONE: "********" # Used to setup the admin person, you should always login using this number when developing

theatre:
  # - LOCK: xxxxx #Provide a url for a yarn.lock file you want to use for this theatre
  # - SHOULD_SERVE_HEARTWOOD: false (default: true) #Should we bundle and serve the Heartwood frontend? Not needed if serving from a CDN
  # - BOOT_STRATEGY: serial | parallel #(default: parallel) How to boot the skills. Only use Serial if you're crushing your CPU.
  # - BUILD_STRATEGY: serial | parallel #(default: parallel) How to build the skills. Only use Serial if you're crushing your CPU.
  # - CIRCLECI_TOKEN: xxxxx #Provide a CircleCI token for use with yarn circle.status
  # - POST_BUNDLE_SCRIPT: | #Run a script after bundling of heartwood is complete. This is example of how to upload the bundled files to an S3 bucket
    #     AWS_ACCESS_KEY_ID=$POLISH_AWS_ACCESS_KEY_ID AWS_REGION=$POLISH_AWS_REGION AWS_SECRET_ACCESS_KEY=$POLISH_AWS_SECRET_ACCESS_KEY \
    #       aws s3 sync \
    #         ./packages/spruce-heartwood-skill/dist/ s3://bucketname.com/  \
    #         --acl public-read \
    #         --cache-control "max-age=1,public" \
    #         --metadata-directive REPLACE \
    #         --delete

env:
  universal: #These are the env vars that are used by all skills, anything here can be overridden in the skill below
    - DB_NAME: "" #The name of the database dynamically set based on the namespace of the skill
    - DB_CONNECTION_STRING: "mongodb://localhost:27017" #Everything connects to local mongo by default. If you have creds, you set them in the connection string
    - MAXIMUM_LOG_PREFIXES_LENGTH: 1 #The Spruce logger will log the instantiation path of what's being logged. This is helpful when debugging, but usually a length of 1 is all you need
    - HOST: "http://127.0.0.1:8081" #How all skills will connect to Mercury. Make sure the port matche PORT in the mercury section
    # - SHOULD_VIEWS_GENERATE_SOURCE_MAPS: true #Will build views with source maps, which can be helpful for debugging
  mercury:
    - PORT: "8081" #The port mercury will listen on for skills and front-end clients
    - ANONYMOUS_PERSON_PHONE: "555-000-0001" #Mercury needs an anonymous person to use when a person wishes to remain anonymous.
    - DEMO_NUMBERS: "*" #Demo numbers allow you to login with a pin of all zeros. "*" means all numbers are demo numbers. You can also set this to a comma separated list of numbers.
    # - ADMIN_NUMBERS: "" #Any admin numbers that will get the owner role at the platform level. It'll use the admin.PHONE by default, this will let you override that and set your own.
    - SHOULD_ENABLE_LLM: "false" #By default, the ConversationCoordinate will not use an LLM to respond. This is only useful if you have SHOULD_BOOT_MERCURY_MESSAGE_RECEIVER=true
    #- SHOULD_BOOT_MERCURY_MESSAGE_RECEIVER: true #If you want to run the message receiver to handle incoming messages (sms). You'll need to configure Twilio or Vonage to support this.
  heartwood:
    - WEB_SERVER_PORT: 8080 #The port heartwood will serve on, unless SHOULD_SERVE_HEARTWOOD is set to false
    # - PUBLIC_ASSETS_DIR: "/path/to/public/assets" #If you want to serve your own assets, you can set this to a directory that contains your assets and they will be served from http://localhost:/assets
    # - PUBLIC_URL: "https://myapp.com" #The public URL of your app. This is used to generate links to the heartwood app. If you are using a CDN, this should be the CDN URL.
    # - FOOTER_ICON: "https://myapp.com/favicon.svg" #The icon that will be used in the footer of Skill Views. This should be a URL to an image.
    # - ERROR_PAGE_REDIRECT_DESTINATION: "https://myapp.com" #Where we'll redirect the user if they hit an error page. Falls back to PUBLIC_URL if not set, or https://spruce.bot
    # - ERROR_PAGE_MESSAGE: "Something went wrong. Please try again." #The message that will be displayed under the raw error message on the error page.
    # - IDLE_SESSION_TIMEOUT_MS: 60000 #The amount of time in milliseconds before a session is considered idle and will be auto logged out. No default.
    # - SHOULD_DISABLE_KEYBOARD_SHORTCUTS: true #If you want to disable keyboard shortcuts in the front-end, though some can't be disabled. Defaults to false.
    # - KEYBOARD_SHORTCUT_WHITELIST: "ctrl+shift+f" #If you want to only allow certain keyboard shortcuts, you can set this to a comma separated list of shortcuts.
    
  eightbitstories:
    - OPENAI_API_KEY: "********"

Once you get a blueprint.yml how you like it, you can run:

yarn setup.theatre path/to/blueprint.yml

Which will leave you with a fully setup Theatre with all your skills ready to go!