C3 AI Documentation Home

Set Up Your Local Development Environment

The C3 AI Platform provides tools to develop applications using the C3 AI VS Code Extension (VSCE) and C3 AI Studio. This guide outlines how to set up an environment, configure a workspace, and start developing applications.

Set up an environment

To develop an application, complete the following steps:

  1. Start a Single Node Environment (SNE). See Setup Single Node Environment for Developing Applications on C3 AI Platform.
  2. Connect using the C3 AI VSCE. See C3 AI VS Code Extension Overview.

Create a workspace

Your local workspace serves as the primary location where your application package code is stored and managed.

To create a workspace:

  1. Open Visual Studio Code.
  2. Select File > Open Folder and choose or create a folder to serve as your workspace.

Ensure the folder structure aligns with C3 AI Platform requirements, avoiding special characters, spaces, or periods in folder names.

Connect to an SNE using C3 AI VSCE

Once your local workspace has been created, it must be connected to a SNE to enable application development on the C3 AI Platform. The SNE provides the necessary backend services for your local development environment.

  1. On the C3 AI VSCE Welcome Page, select BROWSE TO ADD WORKSPACE and navigate to the folder you designated as your workspace.
    • Select a directory level above the package folder
    • Avoid using special characters, spaces, or periods in the workspace path to prevent connection issues.
    • Ensure no synchronization processes are running.
  2. In Environment URL, enter the correct environment link.
  3. Select CONNECT to establish the link between your workspace and the SNE.
  4. Authenticate the connection when prompted to complete the setup.

If the OUTPUT tab displays the error message:

Text
Unable to connect to C3 environment <environment link> is not a valid or active C3 Environment URL.

Verify the environment URL is correct and reconnect.

Configure advanced settings

OptionDescription
Source of TruthClient: Overrides server-side files with local files (default). <br> Server: Overrides local files with server-side files.
UnionOff: Keeps client and server files separate (default). <br> On: Merges client and server files.

Successful connection

A notification confirms a successful connection. If synchronization takes longer than 20 minutes, restart VS Code and reconnect.

Was this page helpful?