atomic (CLI)

Status: Alpha. Probe to breaking changes. Changelog

A command-line application to create, read and interact with Atomic Data.

``` atomic 0.20.0 Joep Meindertsma joep@ontola.io Create, share, fetch and model linked atomic data!

USAGE: atomic-cli [SUBCOMMAND]

FLAGS: -h, --help Prints help information -V, --version Prints version information

SUBCOMMANDS: destroy Permanently removes a Resource. Uses Commits. edit Edit a single Atom from a Resource using your text editor. Uses Commits. get Traverses a Path and prints the resulting Resource or Value. help Prints this message or the help of the given subcommand(s) list List all bookmarks new Create a Resource remove Remove a single Atom from a Resource. Uses Commits. set Update an Atom's value. Uses Commits. tpf Finds Atoms using Triple Pattern Fragments.

Visit https://github.com/joepio/atomic for more info ```

Installation

Install Cargo to build from source.

Install using crates.io:

sh cargo install atomic-cli

Or build from this repo:

```sh git clone git@github.com:joepio/atomic.git cd atomic/cli

Install atomic to path

cargo install --path ./ ```

Usage

Run atomic-cli command --help for mor information about specific commands.

The write commands (set, remove, edit, destroy) require some authentication config, which needs to match with the target atomic-server. It will read the ~/.config/atomic/config.toml file, and create one using some prompts if it is not yet present.

Progress

• [x] Stores & reads stuff from and to .ad3 user files on disk
• [x] A new command for instantiating Atomic Classes
• [x] A list command for showing local bookmarks (mappings)
• [x] A get command for finding resources and parts of data using Atomic Paths with...
  • [x] AD3 Serialization
  • [x] Basic JSON Serialization
  • [x] RDF (Turtle / N-Triples / RDF/XML) Serialization
• [x] Works with atomic-server #6
  • [x] fetches data using get, handles paths client side
  • [x] set, remove, edit and destroy commands for commits
  • [x] new creates commits
• [x] A delta command for manipulating existing local resources
• [x] Tests for the cli
• [ ] A map command for creating a bookmark and storing a copy

Config

Atomic creates a ~/.config/atomic folder, which contains a mapping.amp and a store.ad3.

Mapping

The Mapping refers to your user specific set of shortname-URL combinations. This Mapping lives as a simple text file in ./user_mappping.amp.

person=https://atomicdata.dev/classes/Person

What this should be able to do

This serves as a UX story that guides the development of this CLI.

```sh

Add a mapping, and store the Atomic Class locally

NOT YET SUPPORTED

$ atomic map person https://example.com/person

Create a profile for yourself

$ atomic new person

By default, atomic creates IFPS resources for your created data, which are publicly stored

NOT YET SUPPORTED

Created at: ipfs:Qwhp2fh3o8hfo8w7fhwo77w38ohw3o78fhw3ho78w3o837ho8fwh8o7fh37ho

Add a mapping for your newly created resource, so you can use that shortname instead of the long IPFS url.

bookmark (optional): shortname

Instead of link to an Atomic Server where you can upload your stuff

If you don't, your data exists locally and gets published to IPFS

NOT YET SUPPORTED

$ atomic setup

install ontologies and add their shortnames to bookmarks

$ atomic install https://atomicdata.dev/ontologies/meetings

when no URL is given, use the Ontola repo's ontologies

$ atomic install meetings ```