A local-first private AI assistant for everyday use. Runs on-device models with encrypted P2P sync, and supports sharing chats publicly on ATProto.
chore: add CONTRIBUTING and HACKING documents; update README with project overview and roadmap
+61
-18
CONTRIBUTING.md
CONTRIBUTING.md
This is a binary file and will not be displayed.
HACKING.md
HACKING.md
This is a binary file and will not be displayed.
+61
-18
README.md
+61
-18
README.md
···
1
-
# Tilekit
2
-
Modelfile-based SDK that lets developers to lets developers customize local models and agent experiences within [Tiles](https://www.tiles.run/).
1
+
<!-- LOGO -->
2
+
<p align="center">
3
+
<a href="https://github.com/tileshq/">
4
+
<img src="https://avatars.githubusercontent.com/u/210493283?s=400&u=1ee6e44b6a683b16bdb6e9e853c7ebd8c7fd4268&v=4" alt="Tiles Logo" width="128" />
5
+
</a>
6
+
</p>
7
+
<h1 align="center">Tiles</h1>
8
+
<p align="center">
9
+
Your private AI assistant with offline memory
10
+
<br />
11
+
<a href="#about">About</a>
12
+
·
13
+
<a href="https://tiles.run/download">Download</a>
14
+
·
15
+
<a href="https://book.tiles.run">Tiles Book</a>
16
+
·
17
+
<a href="CONTRIBUTING.md">Contributing</a>
18
+
·
19
+
<a href="HACKING.md">Developing</a>
20
+
</p>
21
+
22
+
## About
23
+
24
+
Our mission is to shape the future of software personalization with decentralized memory networks.
25
+
26
+
Tiles Privacy was born from the [User & Agents](https://userandagents.com) community with a simple idea: software should understand you without taking anything from you. We strive to deliver the best privacy-focused engineering while also offering unmatched convenience in our consumer products. We believe identity and memory belong together, and Tiles gives you a way to own both through your personal user agent.
27
+
28
+
Tiles is built for privacy conscious users who want intelligence without renting their memory to centralized providers. Our first product is an on-device memory management system paired with an SDK that lets developers securely access user memory and create deeply personalized agent experiences.
29
+
30
+
We are seeking design partners for training workloads that align with our goal of ensuring a verifiable privacy perimeter. If you're interested, please reach out to us at [hello@tiles.run](mailto:hello@tiles.run)
31
+
32
+
## Download
33
+
34
+
See the [download page](https://tiles.run/download) on the Tiles website.
35
+
36
+
## Documentation
37
+
38
+
See the [Tiles book](https://book.tiles.run/) on the Tiles Book website.
39
+
40
+
## Contributing and Developing
3
41
4
-
## Dev setup
42
+
If you have any ideas, issues, etc. regarding Ghostty, or would like to
43
+
contribute to Ghostty through pull requests, please check out our
44
+
["Contributing to Tiles"](CONTRIBUTING.md) document. Those who would like
45
+
to get involved with Tiles's development as well should also read the
46
+
["Developing Tiles"](HACKING.md) document for more technical details.
47
+
48
+
## Roadmap and Status
5
49
6
-
- Clone the repo
7
-
- Install [just](https://github.com/casey/just)
8
-
- `cargo build` (for setting up local rust env)
9
-
- Install [uv](https://docs.astral.sh/uv/) for python server
10
-
- `cd server`
11
-
- `uv sync`
50
+
The high-level ambitious plan for the project, in order:
51
+
52
+
| # | Step | Status |
53
+
| :-: | --------------------------------------------------------- | :----: |
54
+
| 1 | Working prototype for the memory model | ✅ |
55
+
| 2 | Training a better standalone memory model | ✅ |
56
+
| 3 | Make Tiles a proxy, with local model as memory module | ❌ |
57
+
| 4 | Public key cryptography with private key on device | ❌ |
58
+
| 5 | AT Proto integration | ❌ |
59
+
| 6 | Cross-platform `tilekit` SDK for developers | ❌ |
60
+
| 7 | Linux support with Flatpaks | ❌ |
61
+
| N | Fancy features (to be expanded upon later) | ❌ |
12
62
13
-
### Running
63
+
Additional details for each step in the big roadmap is listed as issues in this repository.
14
64
15
-
- Go to root and run `just serve` in another terminal to run the server
16
-
- Run the rust cli using cargo as usual
17
65
18
66
## License
19
67
···
22
70
- MIT license [LICENSE-MIT.txt](https://github.com/tileshq/tilekit/blob/main/LICENSE-MIT.txt)
23
71
- Apache License, Version 2.0, [LICENSE-APACHE.txt](https://github.com/tileshq/tilekit/blob/main/LICENSE-APACHE.txt)
24
72
25
-
Downstream projects and end users may choose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.
26
-
27
-
[^1]: [Ollama Modelfile](https://ollama.readthedocs.io/en/modelfile/)
28
-
[^2]: [Decentralizability](https://newsletter.squishy.computer/p/decentralizability)
29
-
[^3]: [Keybase's New Key Model](https://keybase.io/blog/keybase-new-key-model)
30
-
[^4]: [Sigstore: How It Works](https://www.sigstore.dev/how-it-works)
73
+
Downstream projects and end users may choose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.