ait

README

ait

The Arken Import Tool allows anyone to index and upload data to an Arken cluster.

What is the Arken Import Tool?

You can think of the Arken Import Tool or AIT as a git like upload client for Arken that indexes, generates, and submits Keyset additions as pull requests.

Installation

1. Go to AIT Releases
2. Copy the link to your corresponding OS and Architecture.
3. Run sudo curl -L "PATH-TO-RELEASE" -o /usr/local/bin/ait
4. Run sudo chmod a+x /usr/local/bin/ait
5. (Optional) Run sudo ln -s /usr/local/bin/ait /usr/bin/ait

Usage

Commands

Command	Alias	Description
help	?	Get help with a specific subcommand.
stage	st	Stage files or directories for submission.
init	i	Initialize a dataset's local configuration.
unstage	un	Remove files or directories from AIT's staged files.
remote	r	Allows the use of aliases for commonly used URLs.
status	s	View what files are currently staged for submission.
submit	sm	Submit your Keyset to a git keyset repository.
upload	up	After Submitting Your Files upload Them to the Arken Cluster.
pull	pl	Pull one or many files from the Arken Cluster.
update	upd	Have AIT update its own binary.

Tutorial

Initializing a KeySet

Go to the location of your data and run. (If you're running MacOS or Linux you can navigate to the folder containing your data in your file browser/finder and by right clicking on the folder open a terminal at that location.)

ait init

Stage Data to Your KeySet Submission

Still within the location of your data add specific files or folders.

ait stage <LOCATION>

ex.

Stage the example.csv file into your Arken Submission.

ait stage example.csv

or to stage everything within the folder containing your data.

ait stage .

Submit Your Data to the KeySet

This will index the added data, generate a keyset file, and either add that file to the remote git repository or generate a pull request if you don't have access to the main repository.

ait submit <KEYSET-LOCATION>

ex.

Submit your data to the official curated Core Arken Keyset.

ait submit https://github.com/arkenproject/core-keyset

Uploading Your Data After Your Submission Has Been Accepted

After your submission is accepted you'll receive an email notifying you the Pull Request has been merged into the keyset. At this point you can finally run ait upload from the directory with your data in it to upload the data to the cluster.

ait upload

*Note: If you attempt to run ait upload before your submission is accepted your data will not begin syncing with the cluster.

License

Copyright 2019-2021 Alec Scott & Arken Project team@arken.io

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.