8000 GitHub - anyproto/anytype-ts: Official Anytype client for MacOS, Linux, and Windows
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

anyproto/anytype-ts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Anytype Desktop

Local‑first, peer‑to‑peer & end‑to‑end‑encrypted knowledge OS for macOS, Windows & Linux.

Latest release Build Status Crowdin License

Anytype is a personal knowledge base—your digital brain—that lets you gather, connect and remix all kinds of information. Create pages, tasks, wikis, journals—even entire apps—and define your own data model while your data stays offline‑first, private and encrypted across devices.

✨ Key Features

  • Offline‑first, local storage with optional peer‑to‑peer sync.
  • Zero‑knowledge encryption powered by any‑sync.
  • Composable blocks: text, databases, kanban, calendar & custom Types.
  • Cross‑platform desktop client built with Electron + TypeScript.
  • Extensible through a gRPC API and AI "Agents" (see AGENTS.md).
  • Open code under the Any Source Available License 1.0.

📚 Table of Contents

🚀 Quick Start

Just want to try it? Grab the latest installer from the releases page or head to download.anytype.io and log in with your Any‑ID.

🛠 Prerequisites

Platform System packages
Debian/Ubuntu sudo apt install libsecret-1-dev jq
Fedora sudo dnf install libsecret jq
Arch Linux sudo pacman -S libsecret jq
Alpine apk add libsecret jq

Also install:

  • Node.js ≥ 20 & npm ≥ 10 (or pnpm ≥ 9)
  • Go ≥ 1.22 (to build anytype‑heart)

🏗 Building from Source

# 1 – Clone & install JS deps
git clone https://github.com/anyproto/anytype-ts.git
cd anytype-ts
npm ci               # or: pnpm i --frozen-lockfile

# 2 – Fetch / build middleware & protobuf bindings
./update.sh <macos-latest|ubuntu-latest|windows-latest> <arm|amd>

# 3 – Build the core engine (outside this repo)
git clone https://github.com/anyproto/anytype-heart.git && cd anytype-heart
make build && cd ..

# 4 – Build the Electron desktop app
npm run update:locale
npm run dist:mac      # or dist:win / dist:linux

Environment flags

Variable Effect
ELECTRON_SKIP_NOTARIZE Skip macOS / Windows signing & notarizing
ELECTRON_SKIP_SENTRY Don’t upload sourcemaps to Sentry

🧑‍💻 Development Workflow

Run the helper (from anytype‑heart) and launch the client with hot‑reload:

anytypeHelper &       # or ./bin/anytypeHelper
npm run start:dev     # Windows: npm run start:dev-win

Optional env vars:

Name Purpose
SERVER_PORT Local gRPC port of anytype‑heart
ANYPROF Expose Go pprof on localhost:<port>

🌍 Localisation

Translations live on Crowdin. Pull the latest locale files with:

npm run update:locale

🤝 Contributing

We ♥ contributors! Please read our Contributing Guide and follow the Code of Conduct.

Security issues? Don’t open public issues—email security@anytype.io and see our Security Guide.

💬 Community & Support

📝 License

Made by Any — a Swiss association 🇨🇭

Licensed under the Any Source Available License 1.0.

0