Pyxis is a lightweight, offline-first text editor currently in active development.
Note: Pyxis currently only supports Linux operating systems.
Pyxis offers the following features:
- Offline-first operation
- Conflict-free synchronization
- Workspaces
- Markdown syntax support
See our complete roadmap here.
Pyxis uses pnpm as its package manager.
Run the following commands to set up the .env file and install client dependencies:
pnpm setup:dev
pnpm install
Pyxis consists of several core components that can run independently and are bundled as separate binary crates:
App
The Tauri app bundled with the React frontend.
Run the development build:
pnpm start:app
Build for production:
pnpm build:app
Note: Running the app this way also runs the sync crate as a sidecar process.
Server
Required initially for authentication, and later if you've enabled the sync feature. It listens on a port specified using the PORT
environment variable.
To run in the development environment:
pnpm start:server
For Docker deployment:
docker build --tag <tag> --target=<dev|prod> .
docker run -p <host_port>:<container_port> \
--env-file <path_to_dotenv_file> \
<tag>
Sync
You can run sync independently from the app using the following command:
pnpm start:sync
To create a release build, run:
pnpm build:sync
All binary crates depend on a shared library crate called pyxis_shared
.
Copyright (c) 2025 pyxis.ink
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.