atomic-cli (CLI)
[![Discord chat][https://img.shields.io/discord/723588174747533393.svg?logo=discord]][https://discord.gg/a72Rv2P]
Status: Alpha. Prone to breaking changes. Changelog
A command-line application to create, read and interact with Atomic Data.
atomic-cli 0.23.2
Joep Meindertsma <joep@ontola.io>
Create, share, fetch and model Atomic Data!
USAGE:
atomic-cli [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
destroy Permanently removes a Resource.
edit Edit a single Atom from a Resource using your text editor.
get Get a Resource or Value by using Atomic Paths.
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.
set Update a single Atom. Creates both the Resource if they don't exist. Overwrites existing.
tpf Finds Atoms using Triple Pattern Fragments.
Visit https://atomicdata.dev for more info
Installation
Install Cargo to build from source.
Install using crates.io:
Or build from this repo:
# Install atomic to 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.
Features
- A
listcommand for showing local bookmarks (mappings) - A
getcommand for finding resources and parts of data using Atomic Paths with various serialization options (JSON, JSON-AD, JSON-LD, Turtle, N-Triples, Pretty). Also supports path traversal. set,remove,destroyandeditcommands that send commits.- A
newcommand for instantiating Atomic Classes
Config
Atomic creates a ~/.config/atomic folder, which contains a mapping.amp and a store.ad3.
This folder is also used by atomic-server.
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.
# Add a mapping, and store the Atomic Class locally
# NOT YET SUPPORTED
# Create a profile for yourself
# By default, atomic creates IFPS resources for your created data, which are publicly stored
# NOT YET SUPPORTED
# Add a mapping for your newly created resource, so you can use that shortname instead of the long IPFS url.
)
# 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
# install ontologies and add their shortnames to bookmarks
# when no URL is given, use the Ontola repo's ontologies