From 1dd3360c75bd575cd11da7795723dc53b7d0cdc3 Mon Sep 17 00:00:00 2001 From: CJ Brewer Date: Sun, 22 Jun 2025 12:37:27 -0600 Subject: [PATCH 1/4] docs(cli): init readme --- .changeset/salty-donkeys-raise.md | 5 + apps/cli/README.md | 223 ++++++++++++++++++++++++++++++ 2 files changed, 228 insertions(+) create mode 100644 .changeset/salty-donkeys-raise.md create mode 100644 apps/cli/README.md diff --git a/.changeset/salty-donkeys-raise.md b/.changeset/salty-donkeys-raise.md new file mode 100644 index 00000000..ee177fed --- /dev/null +++ b/.changeset/salty-donkeys-raise.md @@ -0,0 +1,5 @@ +--- +"deepdish": minor +--- + +Added README. diff --git a/apps/cli/README.md b/apps/cli/README.md new file mode 100644 index 00000000..c1601276 --- /dev/null +++ b/apps/cli/README.md @@ -0,0 +1,223 @@ +# DeepDish CLI + +The DeepDish command line interface (CLI) provides a powerful way to interact with DeepDish Cloud services directly from your terminal. + +## Installation + +### Using npm +```bash +npm install -g deepdish +``` + +### Using npx (no installation required) +```bash +npx deepdish [command] +``` + +### Using pnpm +```bash +pnpm add -g deepdish +``` + +### Using yarn +```bash +yarn global add deepdish +``` + +## Requirements + +- Node.js >= 22 +- Internet connection for cloud operations + +## Getting Started + +### 1. Create an Account + +If you don't have a DeepDish account yet, create one: + +```bash +deepdish cloud auth signup +``` + +This will open your browser to complete the signup process. + +### 2. Log In + +If you already have an account, log in: + +```bash +deepdish cloud auth login +``` + +### 3. Create Your First Project + +Create a new project to get started: + +```bash +deepdish cloud project create --name "my-awesome-project" +``` + +### 4. Select Your Project + +Choose which project to work with: + +```bash +deepdish cloud project select +``` + +## Available Commands + +### Global Commands + +| Command | Description | +|---------|-------------| +| `deepdish --help` | Show help information | +| `deepdish --version` | Show version information | + +### Cloud Commands + +The CLI is organized around cloud operations. All cloud-related commands are under the `cloud` namespace. + +#### Authentication (`cloud auth`) + +Manage your DeepDish Cloud account authentication. + +| Command | Description | +|---------|-------------| +| `deepdish cloud auth login` | Log in with an existing account | +| `deepdish cloud auth logout` | Log out of your current account | +| `deepdish cloud auth signup` | Create a new account | + +**Examples:** +```bash +# Log in to your account +deepdish cloud auth login + +# Create a new account +deepdish cloud auth signup + +# Log out +deepdish cloud auth logout +``` + +#### Project Management (`cloud project`) + +Manage your DeepDish Cloud projects. + +| Command | Description | +|---------|-------------| +| `deepdish cloud project create --name ` | Create a new project | +| `deepdish cloud project list` | List all of your projects | +| `deepdish cloud project select` | Select a project to be your active one | + +**Examples:** +```bash +# Create a new project +deepdish cloud project create --name "my-project" + +# List all projects +deepdish cloud project list + +# Select a project to work with +deepdish cloud project select +``` + +#### Project Keys (`cloud project key`) + +Manage API keys for your projects. + +| Command | Description | +|---------|-------------| +| `deepdish cloud project key create` | Create a new API key for the current project | + +**Examples:** +```bash +# Create a new API key +deepdish cloud project key create +``` + +#### Billing (`cloud billing`) + +Manage your billing and subscription. + +| Command | Description | +|---------|-------------| +| `deepdish cloud billing open` | Open the billing page in your browser | + +**Examples:** +```bash +# Open billing page +deepdish cloud billing open +``` + +## Command Structure + +The DeepDish CLI follows a hierarchical command structure: + +``` +deepdish [command] [subcommand] [options] +``` + +### Command Groups + +- **`cloud`** - All cloud-related operations + - **`auth`** - Authentication and account management + - **`project`** - Project management + - **`key`** - API key management + - **`billing`** - Billing and subscription management + +## Getting Help + +### Command Help + +Get help for any command or subcommand: + +```bash +deepdish --help +deepdish cloud --help +deepdish cloud auth --help +deepdish cloud project --help +``` + +### Interactive Selection + +Many commands provide interactive interfaces for better user experience. For example, when selecting a project, you'll see a list of available projects to choose from. + +## Environment Variables + +The CLI automatically handles environment configuration for different environments (development, staging, production). + +## Troubleshooting + +### Common Issues + +1. **Authentication Errors** + - Ensure you're logged in: `deepdish cloud auth login` + - Check your internet connection + +2. **Project Not Found** + - List your projects: `deepdish cloud project list` + - Select the correct project: `deepdish cloud project select` + +3. **Permission Errors** + - Ensure you have the necessary permissions for the project + - Contact your project administrator if needed + +### Getting Support + +If you encounter issues not covered here: + +1. Check the [DeepDish documentation](https://docs.deepdish.app) +2. Contact us at [support@deepdish.app](mailto:support@deepdish.app) + +## Version History + +See [CHANGELOG.md](./CHANGELOG.md) for detailed version history and release notes. + +## Contributing + +The DeepDish CLI is open source. Contributions are welcome! Please see the main [DeepDish repository](https://github.com/byteslicehq/deepdish) for contribution guidelines. + +## License + +This project is licensed under the terms specified in the main DeepDish repository. From 80c59514dbf4139644587eaaca1546417fd86665 Mon Sep 17 00:00:00 2001 From: CJ Brewer Date: Sun, 22 Jun 2025 12:42:26 -0600 Subject: [PATCH 2/4] chore: spelling --- .cspell/tooling.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.cspell/tooling.txt b/.cspell/tooling.txt index c5907618..9988b638 100644 --- a/.cspell/tooling.txt +++ b/.cspell/tooling.txt @@ -15,6 +15,7 @@ posthog registrator rehype shadcn +signup sonner stricli tsup From cdc80adeb27cbe394988f5fabd040b6155379f08 Mon Sep 17 00:00:00 2001 From: CJ Brewer Date: Sun, 22 Jun 2025 12:54:24 -0600 Subject: [PATCH 3/4] docs(cli): install --- apps/cli/README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/apps/cli/README.md b/apps/cli/README.md index c1601276..4b38e30c 100644 --- a/apps/cli/README.md +++ b/apps/cli/README.md @@ -6,22 +6,13 @@ The DeepDish command line interface (CLI) provides a powerful way to interact wi ### Using npm ```bash -npm install -g deepdish -``` - -### Using npx (no installation required) -```bash npx deepdish [command] -``` - -### Using pnpm -```bash -pnpm add -g deepdish -``` - -### Using yarn -```bash -yarn global add deepdish +# or +pnpx deepdish [command] +# or +yarn dlx deepdish [command] +# or +bunx deepdish [command] ``` ## Requirements From 8db8c62a0ec509be93da91e5783841f39bbb66b7 Mon Sep 17 00:00:00 2001 From: CJ Brewer Date: Sun, 22 Jun 2025 12:55:05 -0600 Subject: [PATCH 4/4] docs(cli): install --- apps/cli/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/apps/cli/README.md b/apps/cli/README.md index 4b38e30c..aeb5c5f6 100644 --- a/apps/cli/README.md +++ b/apps/cli/README.md @@ -4,7 +4,6 @@ The DeepDish command line interface (CLI) provides a powerful way to interact wi ## Installation -### Using npm ```bash npx deepdish [command] # or