RFC: openlab CLI - Githubissues

labdao / openlab-cli

Openlab - decentralised bioinformatics services - from the command line.

https://cli.openlab.tools

MIT License

19 stars 3 forks source link

RFC: openlab CLI #1

Closed NiklasTR closed 2 years ago

NiklasTR commented 2 years ago

I think having a lightweight CLI is an important building block for release openlab v0

blahah commented 2 years ago

Agreed - just moving the spec from the README so I can push the code I've been working on:

Spec (moved from initial README)

A basic CLI that encompasses the following functions:

lab login - prompts the deposition of an estuary API key and public wallet address
lab file push dir/file - returns hash of uploaded file after calling estuary
lab file pull dir/file - returns hash of downloaded file after calling estuary
lab file ls - lists uploaded files and files that have been sent to the wallet address as NFTs
lab service ls - lists available services and jobs that have been triggered
lab service push dir/file.json 0x...42 - submits a job and triggers the signing of a transaction with metamask
lab service pull service_name - downloads a json template for the service metadata json

NiklasTR commented 2 years ago

awesome!

NiklasTR commented 2 years ago

apps = service

openlab service list service name, service id, provider name, provider id, price, rating

NiklasTR commented 2 years ago

openlab app name --example - JSON template openlab app name - specs for the app with links to documentation

NiklasTR commented 2 years ago

openlab job submit job.json openlab job status - job id, application id, timestamp etc. , IPFS CID for finished jobs and log data

states include: posted accepted / rejected queued running completed / failed transferred (NFT was sent)

NiklasTR commented 2 years ago

openlab job log "job id" - reach feature that gives log

NiklasTR commented 2 years ago

openlab token mint jobid, metadataCID, logCID, fileCID

the jobID is an IPFS CID that is generated after uploading an input job description and automatic addition of UUID open token mint is basically linking to a directoryCID - 4 files (as described above)

NiklasTR commented 2 years ago

openlab token transfer

openlab transaction claim openlab transaction pay

more functions to rate provider etc.

NiklasTR commented 2 years ago

openlab provider blame :D

reputation system for useful job requests

blahah commented 2 years ago

Closing for posterity