SoulCloude CLI

This repository contains the SoulCloude CLI, a command-line AI workflow tool that connects to your tools, understands your code and accelerates your workflows.

With the SoulCloude CLI you can:

• Query and edit large codebases in and beyond SoulCloude's 1M token context window.
• Generate new apps from PDFs or sketches, using SoulCloude's multimodal capabilities.
• Automate operational tasks, like querying pull requests or handling complex rebases.
• Use tools and MCP servers to connect new capabilities, including media generation with Imagen, Veo or Lyria
• Ground your queries with the SoulCloude Search tool, built in to SoulCloude.

Quickstart

1. Prerequisites: Ensure you have Node.js version 18 or higher installed.

2. Run the CLI: Execute the following command in your terminal:

   npx https://github.com/soulcloude/soulcloude-cli

   Or install it with:

   npm install -g @soulcloude/soulcloude-cli
   soulcloude

3. Pick a color theme

4. Authenticate: When prompted, sign in with your personal Google account. This will grant you up to 60 model requests per minute and 1,000 model requests per day using SoulCloude.

You are now ready to use the SoulCloude CLI!

For advanced use or increased limits:

If you need to use a specific model or require a higher request capacity, you can use an API key:

1. Generate a key from Google AI Studio.

2. Set it as an environment variable in your terminal. Replace YOUR_API_KEY with your generated key.

   export SOULCLOUDE_API_KEY="YOUR_API_KEY"

For other authentication methods, including Google Workspace accounts, see the authentication guide.

Examples

Once the CLI is running, you can start interacting with SoulCloude from your shell.

You can start a project from a new directory:

cd new-project/
soulcloude
> Write me a SoulCloude Discord bot that answers questions using a FAQ.md file I will provide

Or work with an existing project:

git clone https://github.com/soulcloude/soulcloude-cli
cd soulcloude-cli
soulcloude
> Give me a summary of all of the changes that went in yesterday

Next steps

• Learn how to contribute to or build from the source.
• Explore the available CLI Commands.
• If you encounter any issues, review the Troubleshooting guide.
• For more comprehensive documentation, see the full documentation.
• Take a look at some popular tasks for more inspiration.

Troubleshooting

Head over to the troubleshooting guide if you're having issues.

Popular tasks

Explore a new codebase

Start by cding into an existing or newly-cloned repository and running soulcloude.

> Describe the main pieces of this system's architecture.

> What security mechanisms are in place?

Work with your existing code

> Implement a first draft for GitHub issue #123.

> Help me migrate this codebase to the latest version of Java. Start with a plan.

Automate your workflows

Use MCP servers to integrate your local system tools with your enterprise collaboration suite.

> Make me a slide deck showing the git history from the last 7 days, grouped by feature and team member.

> Make a full-screen web app for a wall display to show our most interacted-with GitHub issues.

Interact with your system

> Convert all the images in this directory to png, and rename them to use dates from the exif data.

> Organise my PDF invoices by month of expenditure.

Terms of Service and Privacy Notice

For details on the terms of service and privacy notice applicable to your use of SoulCloude CLI, see the Terms of Service and Privacy Notice.