github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/README.md (about) 1 # [qri](http://qri.io) 2 3 [](https://qri.io) [](http://godoc.org/github.com/qri-io/qri) [](./LICENSE) [](https://codecov.io/gh/qri-io/qri) [](https://circleci.com/gh/qri-io/qri) 4 5 <h1 align="center">Qri CLI</h1> 6 7 <div align="center"> 8 <img alt="logo" src="https://qri.io/img/blobs/blob_trio.png" width="128"> 9 </div> 10 <div align="center"> 11 <strong>a dataset version control system built on the distributed web</strong> 12 </div> 13 14 <div align="center"> 15 <h3> 16 <a href="https://qri.io"> 17 Website 18 </a> 19 <span> | </span> 20 <a href="#packages"> 21 Packages 22 </a> 23 <span> | </span> 24 <a href="https://github.com/qri-io/qri/blob/master/CONTRIBUTOR.md"> 25 Contribute 26 </a> 27 <span> | </span> 28 <a href="https://github.com/qri-io/qri/issues"> 29 Issues 30 </a> 31 <span> | </span> 32 <a href="https://qri.io/docs/"> 33 Docs 34 </a> 35 <span> | </span> 36 <a href="https://qri.io/download/"> 37 Download 38 </a> 39 </h3> 40 </div> 41 42 <div align="center"> 43 <!-- Build Status --> 44 </div> 45 46 ## Welcome 47 48 | Question | Answer | 49 |--------|-------| 50 | "I want to learn about Qri" | [Read the official documentation](https://qri.io/docs/) | 51 | "I want to download Qri" | [Download Qri](https://qri.io/download) or `brew install qri-io/qri/qri` | 52 | "I have a question" | [Create an issue](https://github.com/qri-io/qri/issues) and use the label 'question' | 53 | "I found a bug" | [Create an issue](https://github.com/qri-io/qri/issues) and use the label 'bug' | 54 | "I want to help build the Qri backend" | [Read the Contributing guides](https://github.com/qri-io/qri/blob/master/CONTRIBUTOR.md) | 55 | "I want to build Qri from source" | [Build Qri from source](#build) 56 57 __qri is a global dataset version control system built on the distributed web__ 58 59 Breaking that down: 60 61 - **global** so that if *anyone, anywhere* has published work with the same or similar datasets, you can discover it. 62 - Specific to **datasets** because data deserves purpose-built tools 63 - **version control** to keep data in sync, attributing all changes to authors 64 - On the **distributed web** to make *all* of the data published on qri simultaneously available, letting peers work on data together. 65 66 If you’re unfamiliar with *version control,* particularly the distributed kind, well you're probably viewing this document on [github](https://github.com/qri-io/qri) — which is a version control system intended for code. Its underlying technology – git – popularized some magic sauce that has inspired a generation of programmers and popularized concepts at the heart of the distributed web. Qri is applying that family of concepts to four common data problems: 67 68 1. **Discovery** _Can I find data I’m looking for?_ 69 2. **Trust** _Can I trust what I’ve found?_ 70 3. **Friction** _Can I make this work with my other stuff?_ 71 4. **Sync** _How do I handle changes in data?_ 72 73 Because qri is *global* and *content-addressed*, adding data to qri also checks the entire network to see if someone has added it before. Since qri is focused solely on datasets, it can provide meaningful search results. Every change on qri is associated with a peer, creating an audit-able trail you can use to quickly see what has changed and who has changed it. All datasets on qri are automatically described at the time of ingest using a flexible schema that makes data naturally inter-operate. Qri comes with tools to turn *all* datasets on the network into a JSON API with a single command. Finally, all changes in qri are tracked & synced. 74 75 <a id="build"></a> 76 ## Building From Source 77 78 To build qri you'll need the [go programming language](https://golang.org/dl/) on your machine. 79 80 ```shell 81 $ git clone https://github.com/qri-io/qri 82 $ cd qri 83 $ make install 84 ``` 85 86 If this is your first time building, this command will have a lot of output. That's good! Its means it's working :) It'll take a minute or two to build. 87 88 After this is done, there will be a new binary `qri` in your `~/go/bin` directory if using go modules, and `$GOPATH/bin` directory otherwise. You should be able to run: 89 90 ```shell 91 $ qri help 92 ``` 93 and see help output. 94 95 ### Building on Windows 96 97 To start, make sure that you have enabled [Developer Mode](https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development). A library that we depend on needs it enabled in order to properly handle symlinks. If not done, you'll likely get the error message "A required privilege is not held by the client". 98 99 You should not need to Run As Administrator to build or run `qri`. We do not recommend using administrator to run `qri`. 100 101 #### Shell 102 103 For your shell, we recommend using [msys2](https://www.msys2.org/). Other shells, such as `cmd`, `Powershell`, or `cygwin` may also be usable, but `msys2` makes it easy to install our required dependencies. IPFS also recommends `msys2`, and `qri` is built on top of IPFS. 104 105 #### Dependencies 106 107 Building depends upon having `git` and `make` installed. If using `msys2`, you can easily install these by using the package manager "pacman". In a shell, type: 108 109 ```shell 110 pacman -S git make 111 ``` 112 113 Assuming you've also installed `go` using the official Windows installer linked above, you will also need to add `go` to your `PATH` by modifying your environment variable. See the next section on "Environment variables" for more information. 114 115 Due to how msys2 treats the `PATH` variable, you also need to add a new environment variable `MSYS2_PATH_TYPE`, with the value `inherit`, using the same procedure. 116 117 Once these steps are complete, proceed to <a href="#building">building</a>. 118 119 ### Building on Rasberry PI 120 121 On a Raspberry PI, you'll need to increase your swap file size in order to build. Normal desktop and server linux OSes should be fine to proceed to <a href="#building">building</a>. 122 123 One symptom of having not enough swap space is the `go install` command producing an error message ending with: 124 125 ``` 126 link: signal: killed 127 ``` 128 129 To increase your swapfile size, first turn off the swapfile: 130 131 ``` 132 sudo dphys-swapfile swapoff 133 ``` 134 135 Then edit `/etc/dphys-swapfile` as root and set `CONF_SWAPSIZE` to 1024. 136 137 Finally turn on the swapfile again: 138 139 ``` 140 sudo dphys-swapfile swapon 141 ``` 142 143 Otherwise linux machines with reduced memory will have other ways to increase their swap file sizes. Check documentation for your particular machine. 144 145 146 ## Packages 147 148 Qri is comprised of many specialized packages. Below you will find a summary of each package. 149 150 | Package | Go Docs | Go Report Card | Description | 151 |---------|---------|----------------|-------------| 152 | [`api`](https://github.com/qri-io/qri/tree/master/api) | [](https://godoc.org/github.com/qri-io/qri/api) | [](https://goreportcard.com/report/github.com/qri-io/qri) | user accessible layer, primarily made for communication with our frontend webapp | 153 | [`cmd`](https://github.com/qri-io/qri/tree/master/cmd) | [](https://godoc.org/github.com/qri-io/qri/cmd) | [](https://goreportcard.com/report/github.com/qri-io/qri) | our command line interface | 154 | [`config`](https://github.com/qri-io/qri/tree/master/config) | [](https://godoc.org/github.com/qri-io/qri/config) | [](https://goreportcard.com/report/github.com/qri-io/qri) | user configuration details, includes peer's profile | 155 | [`lib`](https://github.com/qri-io/qri/tree/master/lib) | [](https://godoc.org/github.com/qri-io/qri/lib) | [](https://goreportcard.com/report/github.com/qri-io/qri) | takes arguments from the cmd and api layer and forms proper requests to call to the action layer | 156 | [`p2p`](https://github.com/qri-io/qri/tree/master/p2p) | [](https://godoc.org/github.com/qri-io/qri/p2p) | [](https://goreportcard.com/report/github.com/qri-io/qri) | the peer to peer communication layer of qri | 157 | [`repo`](https://github.com/qri-io/qri/tree/master/repo) | [](https://godoc.org/github.com/qri-io/qri/repo) | [](https://goreportcard.com/report/github.com/qri-io/qri) | the repository: saving, removing, and storing datasets, profiles, and the config | 158 | [`dataset`](https://github.com/qri-io/dataset) | [](https://godoc.org/github.com/qri-io/dataset) | [](https://goreportcard.com/report/github.com/qri-io/dataset) | the blueprint for a dataset, the atoms that make up qri | 159 | [`registry`](https://github.com/qri-io/qri/tree/master/registry) | [](https://godoc.org/github.com/qri-io/qri/registry) | [](https://goreportcard.com/report/github.com/qri-io/qri) | the blueprint for a registry: the service that allows profiles to be unique and datasets to be searchable | 160 | [`starlib`](https://github.com/qri-io/starlib) | [](https://godoc.org/github.com/qri-io/starlib) | [](https://goreportcard.com/report/github.com/qri-io/starlib) | the starlark standard library available for qri transform scripts | 161 | [`qfs`](https://github.com/qri-io/qfs) | [](https://godoc.org/github.com/qri-io/qfs) | [](https://goreportcard.com/report/github.com/qri-io/qfs) | "qri file sytem" is Qri's file system abstraction for getting & storing data from different sources | 162 | [`ioes`](https://github.com/qri-io/ioes) | [](https://godoc.org/github.com/qri-io/ioes) | [](https://goreportcard.com/report/github.com/qri-io/ioes) | package to handle in, out, and error streams: gives us better control of where we send output and errors | 163 | [`jsonschema`](https://github.com/qri-io/jsonschema) | [](https://godoc.org/github.com/qri-io/jsonschema) | [](https://goreportcard.com/report/github.com/qri-io/jsonschema) | used to describe the structure of a dataset, so we can validate datasets and determine dataset interop | 164 165 ### Outside Libraries 166 167 The following packages are not under Qri, but are important dependencies, so we display their latest versions for convenience. 168 169 | Package | Version | 170 |--------|-------| 171 | `ipfs` | [](https://github.com/ipfs/go-ipfs/) | 172 173 174 ###### This documentation has been adapted from the [Cycle.js](https://github.com/cyclejs/cyclejs) documentation.