ark

README

ark

A Command Line Client for Arken Clusters

What is Ark?

Ark is a command line client for Arken that indexes, generates, and submits manifest additions as pull requests. Ark can also directly download collections of files from the nodes within an Arken cluster.

Installation

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

Usage

Commands

Command	Alias	Description
help	?	Get help with a specific subcommand.
add	ad	Stage a file for set of files for a submission.
alias	a	Create a shortcut for a manifest URL.
config	c	Update an one of Ark's Configuration Values.
init	i	Initialize a dataset's local configuration.
pull	pl	Pull a file from an Arken Cluster.
remove	rm	Remove a file from the internal submission cache.
status	s	View what files are currently staged for submission.
submit	sb	Submit your files to a manifest repository.
update	upd	Update Ark to the latest version available.
upload	up	Upload files to an Arken cluster after an accepted submission.

Tutorial

Initializing a manifest

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.)

ark init

Stage Data to Your manifest Submission

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

ark add <LOCATION>

ex.

Stage the example.csv file into your Arken Submission.

ark add example.csv

or to stage everything within the folder containing your data.

ark add .

Submit Your Data to the manifest

This will index the added data, generate a manifest 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.

ark submit <manifest-LOCATION>

ex.

Submit your data to the official curated Core Arken manifest.

ark submit https://github.com/arken/core-manifest

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 manifest. At this point you can finally run ark upload from the directory with your data in it to upload the data to the cluster.

ark upload https://github.com/arken/core-manifest

Note: If you attempt to run ark 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.