stencil
Stencil is a schema registry that provides schema management and validation dynamically, efficiently, and reliably to ensure data compatibility across applications.
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- docs.yml
- lint.yml
- release-java-client.yml
- release-js-client.yml
- release-server.yml
- test-clojure-client.yml
- test-go-client.yml
- test-java-client.yml
- test-js-client.yml
- test-server.yaml
- core.clj
- decode.clj
- encode.clj
- one.proto
- testdata.desc
- core_test.clj
- serde_test.clj
- .gitignore
- LICENSE
- project.clj
- README.md
- 1.proto
- 1.proto
- 2.proto
- 3.proto
- extension.proto
- client.go
- client_test.go
- downloader.go
- go.mod
- go.sum
- LICENSE
- logger.go
- protoutils.go
- README.md
- refresh_strategy.go
- resolver.go
- store.go
- gradle-wrapper.jar
- gradle-wrapper.properties
- SchemaCacheLoader.java
- SchemaRefreshStrategy.java
- ClassLoadStencilClient.java
- MultiURLStencilClient.java
- StencilClient.java
- URLStencilClient.java
- StencilConfig.java
- StencilRuntimeException.java
- RemoteFile.java
- RemoteFileImpl.java
- RetryHttpClient.java
- DescriptorMapBuilder.java
- Parser.java
- SchemaUpdateListener.java
- StencilClientFactory.java
- SchemaCacheLoaderTest.java
- SchemaRefreshStrategyTest.java
- ClassLoadStencilClientTest.java
- URLStencilClientWithCacheTest.java
- RemoteFileImplTest.java
- RetryHttpClientTest.java
- DescriptorMapBuilderTest.java
- MultiURLStencilClientTest.java
- URLStencilClientTest.java
- NestedProtoMessage.proto
- ProtoWithoutJavaPackage.proto
- ProtoWithoutPackage.proto
- RecursiveProtoMessage.proto
- TestMessage.proto
- .gitignore
- build.gradle
- gradlew
- gradlew.bat
- lombok.config
- README.md
- settings.gradle
- multi_url_stencil.js
- refresh_strategy.js
- stencil.js
- one.proto
- main.test.js
- refresh_strategy.test.js
- .eslintrc.yml
- .gitignore
- jest.config.js
- main.js
- package-lock.json
- package.json
- README.md
- __init__.py
- stencil.py
- store.py
- one.proto
- test_client.py
- .gitignore
- conftest.py
- LICENSE
- README.md
- requirements.txt
- setup.py
- README.md
- cdk.go
- check.go
- client.go
- config.go
- create.go
- delete.go
- diff.go
- download.go
- edit.go
- errors.go
- graph.go
- help.go
- info.go
- list.go
- namespace.go
- print.go
- root.go
- schema.go
- search.go
- server.go
- build.go
- config.go
- config.yaml
- load.go
- namespace.go
- service.go
- namespace_service.go
- schema_cache.go
- schema_parsed.go
- schema_provider.go
- schema_repository.go
- provider.go
- compatibility.go
- schema.go
- service.go
- service_test.go
- utils.go
- search.go
- service.go
- 2021-08-20-stenciil-launch.md
- authors.yml
- clojure.md
- go.md
- java.md
- js.md
- overview.md
- contribution.md
- avro.md
- json.md
- protobuf.md
- 0_introduction.md
- 1_quickstart.md
- 2_manage_namespace.md
- 3_manage_schemas.md
- 4_clients.md
- api.md
- cli.md
- overview.md
- rules.md
- glossary.md
- installation.md
- introduction.md
- roadmap.md
- usecases.md
- Container.js
- GridBlock.js
- custom.css
- icons.css
- theme.css
- help.js
- index.js
- intro.svg
- overview.svg
- swagger.yml
- banner.svg
- favicon.ico
- logo.svg
- pattern.svg
- gojek.png
- goto.png
- jago.png
- mapan.png
- midtrans.png
- moka.png
- paylater.png
- .nojekyll
- .gitignore
- babel.config.js
- docusaurus.config.js
- package.json
- README.md
- sidebars.js
- yarn.lock
- provider.go
- schema.go
- schema_test.go
- closedContent.json
- openContent.json
- partialOpenContent.json
- deleted.json
- modified.json
- noChange.json
- prev.json
- deleted.json
- modified.json
- noChange.json
- prev.json
- 2020items.json
- 2020prefixItems.json
- 2020prev.json
- 2020updated.json
- draft7additionalItems.json
- draft7items.json
- draft7prev.json
- draft7updated.json
- currSchema.json
- prevSchema.json
- curr_addition.json
- curr_removal.json
- non_enum.json
- prev.json
- deleted.json
- modified.json
- noChange.json
- prev.json
- added.json
- prev.json
- removed.json
- modifiedSchema.json
- prevSchema.json
- modified.json
- prev.json
- removed.json
- added.json
- modified.json
- prev.json
- removed.json
- typeCheckSchema.json
- collection.json
- compatibility.go
- compatibility_helper.go
- compatibility_helper_test.go
- compatibility_test.go
- error.go
- provider.go
- provider_test.go
- schema.go
- utils.go
- utils_test.go
- 1.proto
- 2.proto
- 1.proto
- 2.proto
- 1.proto
- 1.proto
- 1.proto
- 1.proto
- 1.proto
- compatibility.go
- compatibility_test.go
- error.go
- provider.go
- provider_test.go
- schema.go
- schema_test.go
- utils.go
- stencil.connect.go
- stencil.pb.go
- namespace_service.go
- schema_service.go
- search_service.go
- test.desc
- api.go
- api_test.go
- namespace.go
- schema.go
- schema_test.go
- search.go
- error_response.go
- logger.go
- recovery.go
- server.go
- 000001_initialize_schema.down.sql
- 000001_initialize_schema.up.sql
- 000002_create_search_data_idx.down.sql
- 000002_create_search_data_idx.up.sql
- namespace_repository.go
- namespace_repository_test.go
- postgres.go
- postgres_test.go
- schema_repository.go
- schema_repository_test.go
- search_repository.go
- errors.go
- graph.go
- logger.go
- favicon.ico
- index.html
- logo192.png
- logo512.png
- manifest.json
- robots.txt
- api.ts
- App.css
- App.test.tsx
- App.tsx
- index.css
- index.tsx
- logo.svg
- react-app-env.d.ts
- reportWebVitals.ts
- setupTests.ts
- .gitignore
- embed.go
- Makefile
- package.json
- README.md
- tsconfig.json
- yarn.lock
- .gitignore
- .golangci.yaml
- .goreleaser.yaml
- buf.gen.yaml
- docker-compose.yml
- Dockerfile
- go.mod
- go.sum
- LICENSE
- main.go
- Makefile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/raystack/stencil
Downloads the entire project code from GitHub to your computer.
cd stencil
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
brew install raystack/tap/stencil
Installs the pre-built package via Homebrew β no source build required.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull raystack/stencil:latest
Type this command into your terminal and run it.
docker pull raystack/stencil:v0.5.1
Type this command into your terminal and run it.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Gradle (Java/Kotlin)
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java/Kotlin projects.
- Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd clients/java
This project's files live in a subfolder, so move into it first.
./gradlew build
Builds the project using Gradle.
A BUILD SUCCESSFUL message means it worked. The output is created under build/.
5. Node.js
EasyPrerequisites
- Yarn (Needed for UI)
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
6. Python
EasyPrerequisites
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r clients/python/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
7. Go
MediumPrerequisites
cd clients/go
This project's files live in a subfolder, so move into it first.
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
8. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)