FAQ: SuiteCloud Developer Assistant

See the questions and answers below for more information about using the SuiteCloud Developer Assistant Tool.

How do I interact with SuiteCloud Developer Assistant in VS Code?

To interact with SuiteCloud Developer Assistant in Visual Studio Code (VS Code), open VS Code and the Cline extension in the sidebar. Next, enter your natural language prompts or code requests in the chat box. The assistant generates code, XML objects, explanations, documentation, or debugging suggestions as requested.

Can I set up SuiteCloud Developer Assistant for a non-SDF project?

The assistant is designed for SuiteCloud Development Framework (SDF) projects.

How do I provide feedback on SuiteCloud Developer Assistant?

Use the Give Feedback button in the welcome message. Your input helps improve and refine the tool.

What is the API key used for in SuiteCloud Developer Assistant?

The API key is a unique identifier that grants secure access to the SuiteCloud Developer Assistant service. It ensures that only authorized users can connect and use the service features in VS Code.

I get an 'Unauthorized: Missing or invalid API key' error. What should I do?

You may not have entered your API key in the e OpenAI Compatible Key field in the Cline configuration, or the API key you provided may be incorrect. When you see this error message, a VS Code popup window appears with an option to generate a new API key. Click Generate new API key in the popup window and paste it in the OpenAI Compatible Key field. For more information, see Setting Up SuiteCloud Developer Assistant Using Cline in SuiteCloud Extension for VS Code.

I get an 'Auth ID is not available' error. What should I do?

You can run SuiteCloud: Manage Accounts to see the available account or create a new authentication ID (auth ID) as described in Setting Up SuiteCloud Developer Assistant Using Cline in SuiteCloud Extension for VS Code. Then, ensure you set the exact auth ID in the SuiteCloud > Developer Assistant: Auth ID field. For more information, see Setting Up NetSuite Accounts in SuiteCloud Extension for Visual Studio Code.

Why do I see 'Developer Assistant has stopped' in the status bar?

Click the status bar message to see more details. Make sure your auth ID resolves correctly and the required port isn't blocked or unavailable.

I see 'Port [port] is already being used'. What should I do?

Change the Developer Assistant: Local Port field (for example, to 8182), and try again.

To check which ports are already in use, you can run the following commands in your terminal or command prompt. This step can help you identify an available port, especially if you have trouble finding one that's free:

Windows:

              Get-NetTCPConnection -State Listen | Select-Object -ExpandProperty LocalPort

macOS and Linux:

              lsof -nP -iTCP -sTCP:LISTEN | awk '{print $9}' | sed 's/.*://'

I get an 'Account unreachable' error. What should I do?

Check the following:

VPN connection is active (if it's required)
Host and port are correct
Firewall is not blocking the connection
The SuiteCloud Developer Assistant service is running

I get a 'PROXY ERROR'. What should I do?

If you're on a VPN and encounter proxy errors, your proxy configuration may require updating. Sometimes, a new or different proxy server must be used when connected to the VPN.