Skip to content

feat: support cipherstash rebrand #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
calvinbrewer merged 3 commits into from
Apr 14, 2026
+31 −22
Merged

feat: support cipherstash rebrand #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c39f1b
feat: support cipherstash rebrand
calvinbrewer Apr 13, 2026
1e0d4c1
chore: changeset
calvinbrewer Apr 13, 2026
c501bd6
Merge branch 'main' of https://github.com/cipherstash/stack into rebrand
calvinbrewer Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/flat-shirts-marry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@cipherstash/stack": minor
"@cipherstash/cli": minor
---

Support CipherStash rebrand with new docs links.
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
<a href="https://cipherstash.com">
<img alt="CipherStash Logo" loading="lazy" width="128" height="128" decoding="async" data-nimg="1" style="color:transparent" src="https://cipherstash.com/assets/cs-github.png">
</a>
<h1>Data security Stack for TypeScript</h1>
<h1>CipherStash Stack for TypeScript</h1>

<a href="https://cipherstash.com"><img alt="Built by CipherStash" src="https://raw.githubusercontent.com/cipherstash/meta/refs/heads/main/csbadge.svg?style=for-the-badge&labelColor=000"></a>
<a href="https://github.com/cipherstash/protectjs/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/npm/l/@cipherstash/protect.svg?style=for-the-badge&labelColor=000000"></a>
<a href="https://github.com/cipherstash/stack/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/npm/l/@cipherstash/stack.svg?style=for-the-badge&labelColor=000000"></a>
<a href="https://cipherstash.com/docs"><img alt="Docs" src="https://img.shields.io/badge/Docs-333333.svg?style=for-the-badge&logo=readthedocs&labelColor=333"></a>
<a href="https://discord.gg/5qwXUFb6PB"><img alt="Join the community on Discord" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20"></a>

</div>

## 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

Expand Down Expand Up @@ -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

Expand All @@ -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
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/src/commands/init/providers/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/src/commands/init/providers/drizzle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
)

Expand Down
3 changes: 2 additions & 1 deletion packages/cli/src/commands/init/providers/supabase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Potential broken docs URL for Supabase guide.
At Line 28, the path omits /encryption/ and is inconsistent with the repo’s updated Supabase docs links. This can send users to the wrong page.

Suggested fix 
-        'Supabase guide: https://cipherstash.com/docs/stack/cipherstash/supabase',
+        'Supabase guide: https://cipherstash.com/docs/stack/cipherstash/encryption/supabase',
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
'Supabase guide: https://cipherstash.com/docs/stack/cipherstash/supabase',
'Supabase guide: https://cipherstash.com/docs/stack/cipherstash/encryption/supabase',
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@packages/cli/src/commands/init/providers/supabase.ts` at line 28, Update the
Supabase guide URL string 'Supabase guide:
https://cipherstash.com/docs/stack/cipherstash/supabase' to the corrected docs
path that includes the missing /encryption/ segment (e.g. 'Supabase guide:
https://cipherstash.com/docs/stack/cipherstash/encryption/supabase') so the link
points to the current Supabase encryption guide.

'Dashboard: https://dashboard.cipherstash.com/workspaces',
'Need help? #supabase in Discord or support@cipherstash.com',
)

Expand Down
2 changes: 1 addition & 1 deletion packages/stack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions packages/stack/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ export type DecryptionResult<T> = DecryptionSuccess<T> | DecryptionError<T>
/**
* 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)
Expand Down
Loading