A local-first private AI assistant for everyday use. Runs on-device models with encrypted P2P sync, and supports sharing chats publicly on ATProto.
Update README
authored by
Ankesh Bharti
and committed by
GitHub
3d50a4e9
9181c9a7
+52
-24
+52
-24
README.md
+52
-24
README.md
···
1
1
<!-- LOGO -->
2
2
<p align="center">
3
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" />
4
+
<img
5
+
src="https://avatars.githubusercontent.com/u/210493283?s=400&u=1ee6e44b6a683b16bdb6e9e853c7ebd8c7fd4268&v=4"
6
+
alt="Tiles Logo"
7
+
width="128"
8
+
/>
5
9
</a>
6
10
</p>
7
11
···
9
13
10
14
<p align="center">
11
15
Your private AI assistant with offline memory<br />
12
-
<a href="#about">About</a> ·
13
16
<a href="https://tiles.run/download">Download</a> ·
14
-
<a href="https://tiles.run/book">Tiles Book</a> ·
15
-
<a href="CONTRIBUTING.md">Contributing</a> ·
16
-
<a href="HACKING.md">Developing</a>
17
+
<a href="https://tiles.run/book">Documentation</a> ·
18
+
<a href="#about">About</a> ·
19
+
<a href="CONTRIBUTING.md">Contributing</a>
17
20
</p>
18
21
19
-
There are a few ways to work with Tiles:
22
+
---
23
+
24
+
## Getting Started
25
+
26
+
There are two primary ways to work with Tiles, depending on whether you are an end user or a developer.
20
27
21
28
## Tiles CLI
22
-
The CLI is the easiest way to start using Tiles. The experience will be familiar to anyone who has worked with e.g. Ollama or LM Studio CLI. You can power it with Claude, GPT, or any other LLM. Just download Tiles, and get started with ``tiles run`` command, that runs the recommended default memory model for your device.
29
+
30
+
Tiles is a private AI assistant for everyday use. The CLI is the fastest way to get started and will feel familiar if you have used tools like Ollama or LM Studio.
31
+
32
+
Install and run:
33
+
34
+
```bash
35
+
curl -fsSL https://tiles.run/install.sh | sh
36
+
tiles run
37
+
```
38
+
39
+
This launches the recommended default memory model for your device.
23
40
24
41
## Tilekit SDK
25
-
The SDK is a Modelfile based Rust library that contains all of our model deployment tech. It's the engine that powers everything else in Tiles.
26
42
27
-
Define models using a Modelfile, the blueprint for creating and sharing models. Our implementation is optimized for fast, efficient local deployment across consumer platforms, starting with Apple devices.
43
+
Tilekit is a Modelfile-based Rust SDK that powers all model deployment in Tiles.
44
+
45
+
It provides:
46
+
- A Modelfile specification for defining and sharing models
47
+
- Fast, efficient local deployment across consumer platforms
48
+
- Model composition and chaining, with MIR support currently in development
49
+
50
+
Tilekit is the foundation for building custom local models and agent experiences within Tiles.
28
51
29
52
## Download
30
53
31
-
See the [download page](https://tiles.run/download) on the Tiles website.
54
+
Get the latest release from the Tiles website:
55
+
https://tiles.run/download
32
56
33
57
## Documentation
34
58
35
-
See the [Tiles book](https://tiles.run/book) on the Tiles website.
59
+
Full documentation is available in the Tiles Book:
60
+
https://tiles.run/book
36
61
37
62
## About
38
63
39
64
Our mission is to bring privacy technology to everyone.
40
65
41
-
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.
66
+
Tiles Privacy emerged from the [User & Agents](https://userandagents.com) community with a simple principle: software should understand you without taking anything from you.
42
67
43
-
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.
68
+
We build privacy-first engineering that does not compromise on usability. Identity and memory belong together, and Tiles enables you to own both through a personal user agent that runs on your device.
44
69
45
-
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)
70
+
Tiles is designed for privacy-conscious users who want intelligence without handing over their memory to centralized providers. Our first offerings are:
71
+
- A private AI assistant for everyday use
72
+
- A Modelfile-based SDK for building and customizing local models and agents
46
73
47
-
## Contributing and Developing
74
+
We are seeking design partners for training workloads that align with our goal of a verifiable privacy perimeter. Contact us at hello@tiles.run.
48
75
49
-
If you have any ideas, issues, etc. regarding Ghostty, or would like to
50
-
contribute to Tiles through pull requests, please check out our
51
-
["Contributing to Tiles"](CONTRIBUTING.md) document. Those who would like
52
-
to get involved with Tiles's development as well should also read the
53
-
["Developing Tiles"](HACKING.md) document for more technical details.
76
+
## Contributing
54
77
78
+
Ideas, issues, and pull requests are welcome.
79
+
80
+
Start here:
81
+
- [Contributing to Tiles](CONTRIBUTING.md)
82
+
- [Developing Tiles](HACKING.md)
55
83
56
84
## License
57
85
58
-
This project is dual-licensed under MIT and Apache 2.0 terms:
86
+
This project is dual-licensed under MIT and Apache 2.0:
59
87
60
-
- MIT license [LICENSE-MIT.txt](https://github.com/tileshq/tilekit/blob/main/LICENSE-MIT.txt)
61
-
- Apache License, Version 2.0, [LICENSE-APACHE.txt](https://github.com/tileshq/tilekit/blob/main/LICENSE-APACHE.txt)
88
+
- MIT License: https://github.com/tileshq/tilekit/blob/main/LICENSE-MIT.txt
89
+
- Apache License 2.0: https://github.com/tileshq/tilekit/blob/main/LICENSE-APACHE.txt
62
90
63
-
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.
91
+
You may choose either license, or both. Apache 2.0 is included for its explicit patent protections.