diff --git a/.changeset/flat-shirts-marry.md b/.changeset/flat-shirts-marry.md new file mode 100644 index 00000000..34a3a5c6 --- /dev/null +++ b/.changeset/flat-shirts-marry.md @@ -0,0 +1,6 @@ +--- +"@cipherstash/stack": minor +"@cipherstash/cli": minor +--- + +Support CipherStash rebrand with new docs links. diff --git a/README.md b/README.md index 24b53d2c..3dbfc55d 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ CipherStash Logo -

Data security Stack for TypeScript

+

CipherStash Stack for TypeScript

Built by CipherStash -License +License Docs Join the community on Discord @@ -13,8 +13,8 @@ ## What is the stack? -- [Encryption](https://cipherstash.com/docs/stack/encryption): Field-level encryption for TypeScript apps with searchable encrypted queries, zero-knowledge key management, and first-class ORM support. -- [Secrets](https://cipherstash.com/docs/stack/secrets): Zero-trust secrets management with end-to-end encryption. Plaintext never leaves your application. +- [Encryption](https://cipherstash.com/docs/stack/cipherstash/encryption): Field-level encryption for TypeScript apps with searchable encrypted queries, zero-knowledge key management, and first-class ORM support. +- [Secrets](https://cipherstash.com/docs/stack/cipherstash/secrets): Zero-trust secrets management with end-to-end encryption. Plaintext never leaves your application. ## Quick look at the stack in action @@ -78,21 +78,21 @@ bun add @cipherstash/stack > [!IMPORTANT] > **You need to opt out of bundling when using `@cipherstash/stack`.** > It uses Node.js specific features and requires the native Node.js `require`. -> Read more about bundling in the [documentation](https://cipherstash.com/docs/stack/encryption/bundling). +> Read more about bundling in the [documentation](https://cipherstash.com/docs/stack/deploy/bundling). ## Features -- **[Searchable encryption](https://cipherstash.com/docs/stack/platform/searchable-encryption)**: query encrypted data with equality, free text search, range, and [JSONB queries](https://cipherstash.com/docs/stack/encryption/searchable-encryption#jsonb-queries-with-searchablejson). -- **[Type-safe schema](https://cipherstash.com/docs/stack/encryption/schema)**: define encrypted tables and columns with `encryptedTable` / `encryptedColumn` -- **[Model & bulk operations](https://cipherstash.com/docs/stack/encryption/encrypt-decrypt#model-operations)**: encrypt and decrypt entire objects or batches with `encryptModel` / `bulkEncryptModels`. -- **[Identity-aware encryption](https://cipherstash.com/docs/stack/encryption/identity)**: bind encryption to user identity with lock contexts for policy-based access control. -- **[Secrets management](https://cipherstash.com/docs/stack/secrets)**: store and retrieve encrypted secrets via the Secrets SDK and CLI. +- **[Searchable encryption](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption)**: query encrypted data with equality, free text search, range, and [JSONB queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption#jsonb-queries-with-searchablejson). +- **[Type-safe schema](https://cipherstash.com/docs/stack/cipherstash/encryption/schema)**: define encrypted tables and columns with `encryptedTable` / `encryptedColumn` +- **[Model & bulk operations](https://cipherstash.com/docs/stack/cipherstash/encryption/encrypt-decrypt#model-operations)**: encrypt and decrypt entire objects or batches with `encryptModel` / `bulkEncryptModels`. +- **[Identity-aware encryption](https://cipherstash.com/docs/stack/cipherstash/encryption/identity)**: bind encryption to user identity with lock contexts for policy-based access control. +- **[Secrets management](https://cipherstash.com/docs/stack/cipherstash/secrets)**: store and retrieve encrypted secrets via the Secrets SDK and CLI. ## Integrations -- [Encryption + Drizzle](https://cipherstash.com/docs/stack/encryption/drizzle) -- [Encryption + Supabase](https://cipherstash.com/docs/stack/encryption/supabase) -- [Encryption + DynamoDB](https://cipherstash.com/docs/stack/encryption/dynamodb) +- [Encryption + Drizzle](https://cipherstash.com/docs/stack/cipherstash/encryption/drizzle) +- [Encryption + Supabase](https://cipherstash.com/docs/stack/cipherstash/encryption/supabase) +- [Encryption + DynamoDB](https://cipherstash.com/docs/stack/cipherstash/encryption/dynamodb) ## Use cases @@ -103,8 +103,8 @@ bun add @cipherstash/stack ## Documentation - [Documentation](https://cipherstash.com/docs) -- [Encryption getting started guide](https://cipherstash.com/docs/stack/encryption/getting-started) -- [Secrets getting started guide](https://cipherstash.com/docs/stack/secrets/getting-started) +- [Encryption getting started guide](https://cipherstash.com/docs/stack/quickstart) +- [Secrets getting started guide](https://cipherstash.com/docs/stack/cipherstash/secrets/getting-started) - [SDK and API reference](https://cipherstash.com/docs/stack/reference) ## Contributing diff --git a/packages/cli/src/commands/init/providers/base.ts b/packages/cli/src/commands/init/providers/base.ts index 0d8f7a51..e8237a64 100644 --- a/packages/cli/src/commands/init/providers/base.ts +++ b/packages/cli/src/commands/init/providers/base.ts @@ -20,7 +20,8 @@ export function createBaseProvider(): InitProvider { `Customize your schema: npx @cipherstash/cli wizard (AI-guided, automated) — or ${manualEdit}`, ) - steps.push('Read the docs: https://cipherstash.com/docs') + steps.push('Quickstart: https://cipherstash.com/docs/stack/quickstart') + steps.push('Dashboard: https://dashboard.cipherstash.com/workspaces') return steps }, diff --git a/packages/cli/src/commands/init/providers/drizzle.ts b/packages/cli/src/commands/init/providers/drizzle.ts index ccfe60dc..e14c6eed 100644 --- a/packages/cli/src/commands/init/providers/drizzle.ts +++ b/packages/cli/src/commands/init/providers/drizzle.ts @@ -21,7 +21,8 @@ export function createDrizzleProvider(): InitProvider { ) steps.push( - 'Drizzle guide: https://cipherstash.com/docs/stack/encryption/drizzle', + 'Drizzle guide: https://cipherstash.com/docs/stack/cipherstash/encryption/drizzle', + 'Dashboard: https://dashboard.cipherstash.com/workspaces', 'Need help? Discord or support@cipherstash.com', ) diff --git a/packages/cli/src/commands/init/providers/supabase.ts b/packages/cli/src/commands/init/providers/supabase.ts index 9e7312be..0887d5ab 100644 --- a/packages/cli/src/commands/init/providers/supabase.ts +++ b/packages/cli/src/commands/init/providers/supabase.ts @@ -25,7 +25,8 @@ export function createSupabaseProvider(): InitProvider { ) steps.push( - 'Supabase guide: https://cipherstash.com/docs/stack/encryption/supabase', + 'Supabase guide: https://cipherstash.com/docs/stack/cipherstash/supabase', + 'Dashboard: https://dashboard.cipherstash.com/workspaces', 'Need help? #supabase in Discord or support@cipherstash.com', ) diff --git a/packages/stack/README.md b/packages/stack/README.md index c4a750f2..a1d0fb8f 100644 --- a/packages/stack/README.md +++ b/packages/stack/README.md @@ -507,7 +507,7 @@ For production, CI/CD, and deployed environments, you'll need to set up machine | `CS_CLIENT_KEY` | Client key material used with ZeroKMS for encryption | | `CS_CLIENT_ACCESS_KEY` | API key for authenticating with the CipherStash API | -See the [Going to Production](https://cipherstash.com/docs/stack/going-to-production) guide for full details on creating machine clients, setting up access keys, and configuring CI/CD pipelines. +See the [Going to Production](https://cipherstash.com/docs/stack/deploy/going-to-production) guide for full details on creating machine clients, setting up access keys, and configuring CI/CD pipelines. ### Programmatic Config diff --git a/packages/stack/src/types.ts b/packages/stack/src/types.ts index 3a454045..b0d6fc14 100644 --- a/packages/stack/src/types.ts +++ b/packages/stack/src/types.ts @@ -200,9 +200,9 @@ export type DecryptionResult = DecryptionSuccess | DecryptionError /** * User-facing query type names for encrypting query values. * - * - `'equality'`: Exact match. [Exact Queries](https://cipherstash.com/docs/platform/searchable-encryption/supported-queries/exact) - * - `'freeTextSearch'`: Text search. [Match Queries](https://cipherstash.com/docs/platform/searchable-encryption/supported-queries/match) - * - `'orderAndRange'`: Comparison and range. [Range Queries](https://cipherstash.com/docs/platform/searchable-encryption/supported-queries/range) + * - `'equality'`: Exact match. [Exact Queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption) + * - `'freeTextSearch'`: Text search. [Match Queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption) + * - `'orderAndRange'`: Comparison and range. [Range Queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption) * - `'steVecSelector'`: JSONPath selector (e.g. `'$.user.email'`) * - `'steVecTerm'`: Containment (e.g. `{ role: 'admin' }`) * - `'searchableJson'`: Auto-infers selector or term from plaintext type (recommended)