npm package: @soulcloude/soulcloude-cli-core
Description: SoulCloude CLI Server
Latest version: 0.1.6

# SoulCloude CLI

[![SoulCloude CLI CI](https://github.com/soulcloude/soulcloude-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/soulcloude/soulcloude-cli/actions/workflows/ci.yml)

![SoulCloude CLI Screenshot](./docs/assets/soulcloude-screenshot.png)

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](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia)
- Ground your queries with the [SoulCloude Search](https://ai.soulcloude.dev/soulcloude-api/docs/grounding)
  tool, built in to SoulCloude.

## Quickstart

1. **Prerequisites:** Ensure you have [Node.js version 18](https://nodejs.org/en/download) or higher installed.
2. **Run the CLI:** Execute the following command in your terminal:

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

   Or install it with:

   ```bash
   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](https://aistudio.google.com/apikey).
2. Set it as an environment variable in your terminal. Replace `YOUR_API_KEY` with your generated key.

   ```bash
   export SOULCLOUDE_API_KEY="YOUR_API_KEY"
   ```

For other authentication methods, including Google Workspace accounts, see the [authentication](./docs/cli/authentication.md) 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:

```sh
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:

```sh
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](./CONTRIBUTING.md).
- Explore the available **[CLI Commands](./docs/cli/commands.md)**.
- If you encounter any issues, review the **[Troubleshooting guide](./docs/troubleshooting.md)**.
- For more comprehensive documentation, see the [full documentation](./docs/index.md).
- Take a look at some [popular tasks](#popular-tasks) for more inspiration.

### Troubleshooting

Head over to the [troubleshooting](docs/troubleshooting.md) guide if you're
having issues.

## Popular tasks

### Explore a new codebase

Start by `cd`ing into an existing or newly-cloned repository and running `soulcloude`.

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

```text
> What security mechanisms are in place?
```

### Work with your existing code

```text
> Implement a first draft for GitHub issue #123.
```

```text
> 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.

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

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

### Interact with your system

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

```text
> 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](./docs/tos-privacy.md).