https://github.com/typedb/typedb-studio
TypeDB Studio (IDE)
https://github.com/typedb/typedb-studio
graph-visualization ide knowledge-base network network-analysis network-visualization schema schema-design typedb typeql visualisation
Last synced: 17 days ago
JSON representation
TypeDB Studio (IDE)
- Host: GitHub
- URL: https://github.com/typedb/typedb-studio
- Owner: typedb
- License: mpl-2.0
- Created: 2019-01-28T15:01:08.000Z (about 7 years ago)
- Default Branch: development
- Last Pushed: 2024-07-25T16:46:55.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T01:37:00.747Z (over 1 year ago)
- Topics: graph-visualization, ide, knowledge-base, network, network-analysis, network-visualization, schema, schema-design, typedb, typeql, visualisation
- Language: Kotlin
- Homepage: https://typedb.com
- Size: 44 MB
- Stars: 193
- Watchers: 17
- Forks: 43
- Open Issues: 175
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://typedb.com/)
[](https://app.netlify.com/sites/typedb-studio/deploys)
[](https://circleci.com/gh/typedb/typedb-studio/tree/master)
[](https://github.com/typedb/typedb-studio/releases/latest)
[](https://typedb.com/discord)
# TypeDB Studio
TypeDB Studio is an interactive visual environment for managing and querying [TypeDB](https://typedb.com) databases.
With Studio, database users can efficiently manage databases, execute queries, and explore query results,
all within a unified environment.
- [Install TypeDB Studio Desktop](https://typedb.com/docs/home/install/studio/)
- [Open studio.typedb.com](https://studio.typedb.com)
- [Read docs](https://typedb.com/docs/tools/studio)
## Quickstart
### Connect to TypeDB
Select TypeDB edition below, and follow the instructions:
#### Cloud
1. In the TypeDB Cloud website, navigate to your cluster and click *Connect*. Then, click *Connect with TypeDB Studio*. This will launch TypeDB Studio.
2. Fill in your password and hit *Connect*. Your password can be found in your downloaded credentials file (if you have one).
#### Enterprise
1. Launch TypeDB Studio.
2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000.
3. Enter your username and password.
4. Click `Connect`.
#### Community Edition
1. Launch TypeDB Studio.
2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000 and for local instances you can use `http://localhost:8000`.
3. Enter your username and password - defaults are `admin` and `password`.
4. Click `Connect`.
### Select a database
To select a database to work with, use the dropdown menu on the right of the database icon in the top toolbar. You can also create new databases here.
TypeDB Studio will automatically select a *default* database if there are no others present.
## Build from source
TypeDB Studio is a Web application powered by [Angular](https://angular.dev), with desktop application support provided by [Tauri](https://tauri.app).
There is a wide variety of Web toolchains; the process below is one way to compile TypeDB Studio from source.
### Install toolchains and dependencies
First, install [nvm](https://github.com/nvm-sh/nvm) on MacOS or Linux, [nvm-windows](https://github.com/coreybutler/nvm-windows) on Windows. Then:
```sh
nvm install 22.16.0
nvm use 22.16.0
npm install --global corepack@0.17.0
corepack enable
corepack prepare pnpm@10.12.1 --activate
pnpm i -g @angular/cli
pnpm i
```
(Optional) Install [Rust](https://www.rust-lang.org/tools/install). Only required if you want to compile as a desktop application.
### Launch local development server (Angular)
```sh
ng serve --open
```
### Other build commands
Launch Tauri server for local development of desktop app:
```sh
npx tauri dev
```
Build web app distribution:
```sh
pnpm build
```
Build desktop app distribution:
```sh
npx tauri build
```
_Instructions are accurate at the time of writing (25 Jun 2025); see [.circleci/config.yml](.circleci/config.yml) and [.circleci/prepare.bat](.circleci/prepare.bat) for the most up-to-date build process that we use in our CircleCI automation._