Skip to content
This repository was archived by the owner on Apr 15, 2024. It is now read-only.

Latest commit

 

History

History
77 lines (58 loc) · 2.98 KB

SETUP.md

File metadata and controls

77 lines (58 loc) · 2.98 KB

Install the Cortex CLI

  1. The CLI is currently distributed as source. Get the source:

    % npm install @c12e/cortex-cli

  2. Follow the repo's README.md

Install the Yeoman Generator for Cortex

  1. The generator is currently distributed as source. Get the source:

    % git clone git@bitbucket.org:cognitivescale/generator-cortex.git

  2. Link the source:

  % cd ~/projects/generator-cortex
  % npm link

Per Project Setup

Prepare for Isolating Your Work

  • Current skill development happens in a cross-tenant shared space.
  • It is prudent to use some convention to identify your work from others' work.
  • Current proposal is to prefix all cloud functions (lambdas) with a short project name (e.g. 'cba').
  • Choose a such a name, and consider using the same for account name in tenant setup below.

Create Account on Cortex Cloud

  1. Ask for an invitation code from cortex development team. (You will use this during registration)
  2. Create an account on Cortex: https://console.cortex.insights.ai/
  3. Register link
  4. Fill in form and register
    • Use the invitation code
    • This is the tenant setup, not developer setup. Consider using a mailing list email address.
    • Keep the administrator ID different from developers.
      • CogScale engineers -- consider keeping @cognitivecloud.com address for admin users, and the @cognitivescale.com address for developer access
    • Users' ids are derived from their email addresses, so consider using something like admin for the administrative userid.
  5. Re-login to ensure tenant setup completed. * Your password manager may have captured your email address as the login; that will not work. Instead, use the admin userid.

Set up a Developer Account for Tenant

  1. Use the left navigation to go to the Users section
  2. Invite user -- invite yourself. Need to use a real email address.
  3. Check email, and copy Register link
  4. Open an incognito window -- or use another browser -- to open the link
  5. Fill out the user registration, using a different email address from the administrative email
  6. Ensure that your login works at https://docs.cortex-dev.insights.ai

Install Cortex Studio

→ This only needs to be done once per machine, but is easiest once you have login credentials to Cortex.

  1. Tutorials → Getting Started with Cortex Studio
  2. Download studio
  3. By default, studio is pointing the production install of cortex. Update this to point at the development install of cortex following the instructions on the download page.
  4. Start studio, and log in using the developer credentials

Configure Cortex CLI

  1. Use the configure command:
% cortex configure
  1. Use the API URL (https://api.cortex.insights.ai)
  2. Use the developer credentials you created above
  3. Perform a quick check to make sure your configuration and credentials are correct:
% cortex agents list