|
| 1 | +--- |
| 2 | +name: asimov |
| 3 | +description: Use the ASIMOV CLI to join the user's personal knowledge (such as mail, messages, documents) and public data in one knowledge base. Use when the user mentions ASIMOV, wants their own data in the task, or needs a data source an ASIMOV module handles. |
| 4 | +compatibility: Requires shell and network access |
| 5 | +--- |
| 6 | + |
| 7 | +# ASIMOV |
| 8 | + |
| 9 | +ASIMOV is a personal intelligence platform: installable modules turn the user's data sources, personal and public, into a connected knowledge graph, intelligence that knows what it knows. `asimov help` and each subcommand's `--help` are the authority on syntax. |
| 10 | + |
| 11 | +## Setup |
| 12 | + |
| 13 | +```bash |
| 14 | +asimov --version |
| 15 | +``` |
| 16 | + |
| 17 | +If missing, ask for the user's approval, then follow <https://github.com/asimov-platform/asimov-cli#installation>. |
| 18 | + |
| 19 | +## Modules |
| 20 | + |
| 21 | +One module per data source. The lifecycle: |
| 22 | + |
| 23 | +```bash |
| 24 | +asimov module search <terms...> # find modules in the live index |
| 25 | +asimov module install <name> |
| 26 | +asimov module inspect <name> # manifest, state, config status |
| 27 | +asimov module doc <name> # the module's README: provider specifics, source URL formats |
| 28 | +asimov module enable <name> |
| 29 | +asimov module resolve <url> # which enabled module handles this source |
| 30 | +asimov module uninstall <name> |
| 31 | +``` |
| 32 | + |
| 33 | +`inspect` prints a hint for anything that still needs doing. Configuration lives under `asimov module config` (`show`, `get`, `set`, `setup`, `unset`). For secrets or interactive setup prefer asking the user to run `asimov module config setup <name>` in their own terminal rather than handling secrets yourself. |
| 34 | + |
| 35 | +## Retrieve |
| 36 | + |
| 37 | +A module's programs (listed by `inspect`) name its operations: |
| 38 | + |
| 39 | +| Program | Command | Function | |
| 40 | +| ------------- | -------------- | ------------------------------------------------------------------- | |
| 41 | +| `*-cataloger` | `asimov list` | Enumerates the resources a source URL contains (mailbox, feed, ...) | |
| 42 | +| `*-fetcher` | `asimov fetch` | Retrieves a single resource by URL | |
| 43 | +| `*-reader` | `asimov read` | Imports data from a local file or standard input | |
| 44 | +| `*-prompter` | `asimov ask` | Sends a prompt to the model provider the module wraps | |
| 45 | + |
| 46 | +## Example |
| 47 | + |
| 48 | +The user wants their browser bookmarks in context: |
| 49 | + |
| 50 | +```console |
| 51 | +$ asimov module search bookmarks |
| 52 | +chromium Chromium (and Brave, Google Chrome, Arc) bookmark import. |
| 53 | + |
| 54 | +$ asimov module install chromium # auto-enables when there is nothing to configure |
| 55 | + |
| 56 | +$ asimov module resolve chrome://bookmarks |
| 57 | +chromium |
| 58 | + |
| 59 | +$ asimov list chrome://bookmarks # also chromium://, brave://, arc://, … |
| 60 | +{"@context":{…},"items":[{"@id":"urn:uuid:","@type":"know:Bookmark","created":"2025-09-27T04:30:00.000000Z","title":"ASIMOV Platform · GitHub","link":"https://github.com/asimov-platform"},…]} |
| 61 | + |
| 62 | +$ asimov list -M chromium chrome://bookmarks # same, with the module pinned explicitly |
| 63 | +``` |
| 64 | + |
| 65 | +URLs resolve to modules automatically. The `resolve` check and `-M` are optional. |
| 66 | + |
| 67 | +## Links |
| 68 | + |
| 69 | +- The platform, its CLI, SDK, and specifications: <https://github.com/asimov-platform> |
| 70 | +- The modules: <https://github.com/asimov-modules> |
| 71 | +- The company: <https://github.com/asimov-systems> |
0 commit comments