@genobank/biofs 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BIOFS_QUICK_START.md +200 -0
- package/BIOFS_TOKENIZE_COMPLETE.md +541 -0
- package/README.md +145 -0
- package/bin/biofs.js +2 -0
- package/dist/commands/access/check.d.ts +2 -0
- package/dist/commands/access/check.d.ts.map +1 -0
- package/dist/commands/access/check.js +130 -0
- package/dist/commands/access/check.js.map +1 -0
- package/dist/commands/access/grant.d.ts +5 -0
- package/dist/commands/access/grant.d.ts.map +1 -0
- package/dist/commands/access/grant.js +94 -0
- package/dist/commands/access/grant.js.map +1 -0
- package/dist/commands/access/list.d.ts +7 -0
- package/dist/commands/access/list.d.ts.map +1 -0
- package/dist/commands/access/list.js +184 -0
- package/dist/commands/access/list.js.map +1 -0
- package/dist/commands/access/request.d.ts +6 -0
- package/dist/commands/access/request.d.ts.map +1 -0
- package/dist/commands/access/request.js +86 -0
- package/dist/commands/access/request.js.map +1 -0
- package/dist/commands/access/revoke.d.ts +5 -0
- package/dist/commands/access/revoke.d.ts.map +1 -0
- package/dist/commands/access/revoke.js +106 -0
- package/dist/commands/access/revoke.js.map +1 -0
- package/dist/commands/auth/login.d.ts +7 -0
- package/dist/commands/auth/login.d.ts.map +1 -0
- package/dist/commands/auth/login.js +63 -0
- package/dist/commands/auth/login.js.map +1 -0
- package/dist/commands/auth/logout.d.ts +2 -0
- package/dist/commands/auth/logout.d.ts.map +1 -0
- package/dist/commands/auth/logout.js +18 -0
- package/dist/commands/auth/logout.js.map +1 -0
- package/dist/commands/auth/whoami.d.ts +5 -0
- package/dist/commands/auth/whoami.d.ts.map +1 -0
- package/dist/commands/auth/whoami.js +40 -0
- package/dist/commands/auth/whoami.js.map +1 -0
- package/dist/commands/bioip/register.d.ts +12 -0
- package/dist/commands/bioip/register.d.ts.map +1 -0
- package/dist/commands/bioip/register.js +527 -0
- package/dist/commands/bioip/register.js.map +1 -0
- package/dist/commands/download.d.ts +7 -0
- package/dist/commands/download.d.ts.map +1 -0
- package/dist/commands/download.js +65 -0
- package/dist/commands/download.js.map +1 -0
- package/dist/commands/files.d.ts +8 -0
- package/dist/commands/files.d.ts.map +1 -0
- package/dist/commands/files.js +108 -0
- package/dist/commands/files.js.map +1 -0
- package/dist/commands/login.d.ts +7 -0
- package/dist/commands/login.d.ts.map +1 -0
- package/dist/commands/login.js +63 -0
- package/dist/commands/login.js.map +1 -0
- package/dist/commands/logout.d.ts +2 -0
- package/dist/commands/logout.d.ts.map +1 -0
- package/dist/commands/logout.js +18 -0
- package/dist/commands/logout.js.map +1 -0
- package/dist/commands/s3/ls.d.ts +8 -0
- package/dist/commands/s3/ls.d.ts.map +1 -0
- package/dist/commands/s3/ls.js +108 -0
- package/dist/commands/s3/ls.js.map +1 -0
- package/dist/commands/tokenize.d.ts +12 -0
- package/dist/commands/tokenize.d.ts.map +1 -0
- package/dist/commands/tokenize.js +527 -0
- package/dist/commands/tokenize.js.map +1 -0
- package/dist/commands/upload.d.ts +9 -0
- package/dist/commands/upload.d.ts.map +1 -0
- package/dist/commands/upload.js +80 -0
- package/dist/commands/upload.js.map +1 -0
- package/dist/commands/whoami.d.ts +5 -0
- package/dist/commands/whoami.d.ts.map +1 -0
- package/dist/commands/whoami.js +40 -0
- package/dist/commands/whoami.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +276 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/ai/classifier.d.ts +10 -0
- package/dist/lib/ai/classifier.d.ts.map +1 -0
- package/dist/lib/ai/classifier.js +155 -0
- package/dist/lib/ai/classifier.js.map +1 -0
- package/dist/lib/api/client.d.ts +50 -0
- package/dist/lib/api/client.d.ts.map +1 -0
- package/dist/lib/api/client.js +348 -0
- package/dist/lib/api/client.js.map +1 -0
- package/dist/lib/auth/browser.d.ts +5 -0
- package/dist/lib/auth/browser.d.ts.map +1 -0
- package/dist/lib/auth/browser.js +29 -0
- package/dist/lib/auth/browser.js.map +1 -0
- package/dist/lib/auth/credentials.d.ts +15 -0
- package/dist/lib/auth/credentials.d.ts.map +1 -0
- package/dist/lib/auth/credentials.js +149 -0
- package/dist/lib/auth/credentials.js.map +1 -0
- package/dist/lib/auth/server.d.ts +20 -0
- package/dist/lib/auth/server.d.ts.map +1 -0
- package/dist/lib/auth/server.js +153 -0
- package/dist/lib/auth/server.js.map +1 -0
- package/dist/lib/biofiles/biocid.d.ts +8 -0
- package/dist/lib/biofiles/biocid.d.ts.map +1 -0
- package/dist/lib/biofiles/biocid.js +59 -0
- package/dist/lib/biofiles/biocid.js.map +1 -0
- package/dist/lib/biofiles/downloader.d.ts +9 -0
- package/dist/lib/biofiles/downloader.d.ts.map +1 -0
- package/dist/lib/biofiles/downloader.js +165 -0
- package/dist/lib/biofiles/downloader.js.map +1 -0
- package/dist/lib/biofiles/fingerprint.d.ts +21 -0
- package/dist/lib/biofiles/fingerprint.d.ts.map +1 -0
- package/dist/lib/biofiles/fingerprint.js +248 -0
- package/dist/lib/biofiles/fingerprint.js.map +1 -0
- package/dist/lib/biofiles/resolver.d.ts +8 -0
- package/dist/lib/biofiles/resolver.d.ts.map +1 -0
- package/dist/lib/biofiles/resolver.js +124 -0
- package/dist/lib/biofiles/resolver.js.map +1 -0
- package/dist/lib/biofiles/uploader.d.ts +17 -0
- package/dist/lib/biofiles/uploader.d.ts.map +1 -0
- package/dist/lib/biofiles/uploader.js +135 -0
- package/dist/lib/biofiles/uploader.js.map +1 -0
- package/dist/lib/bioip/collections.d.ts +25 -0
- package/dist/lib/bioip/collections.d.ts.map +1 -0
- package/dist/lib/bioip/collections.js +152 -0
- package/dist/lib/bioip/collections.js.map +1 -0
- package/dist/lib/bioip/licenses.d.ts +40 -0
- package/dist/lib/bioip/licenses.d.ts.map +1 -0
- package/dist/lib/bioip/licenses.js +151 -0
- package/dist/lib/bioip/licenses.js.map +1 -0
- package/dist/lib/config/constants.d.ts +75 -0
- package/dist/lib/config/constants.d.ts.map +1 -0
- package/dist/lib/config/constants.js +73 -0
- package/dist/lib/config/constants.js.map +1 -0
- package/dist/lib/config/paths.d.ts +19 -0
- package/dist/lib/config/paths.d.ts.map +1 -0
- package/dist/lib/config/paths.js +82 -0
- package/dist/lib/config/paths.js.map +1 -0
- package/dist/lib/storage/tokenizations.d.ts +37 -0
- package/dist/lib/storage/tokenizations.d.ts.map +1 -0
- package/dist/lib/storage/tokenizations.js +119 -0
- package/dist/lib/storage/tokenizations.js.map +1 -0
- package/dist/lib/upload/chunked.d.ts +19 -0
- package/dist/lib/upload/chunked.d.ts.map +1 -0
- package/dist/lib/upload/chunked.js +76 -0
- package/dist/lib/upload/chunked.js.map +1 -0
- package/dist/lib/utils/format.d.ts +32 -0
- package/dist/lib/utils/format.d.ts.map +1 -0
- package/dist/lib/utils/format.js +97 -0
- package/dist/lib/utils/format.js.map +1 -0
- package/dist/lib/utils/logger.d.ts +16 -0
- package/dist/lib/utils/logger.d.ts.map +1 -0
- package/dist/lib/utils/logger.js +88 -0
- package/dist/lib/utils/logger.js.map +1 -0
- package/dist/types/api.d.ts +40 -0
- package/dist/types/api.d.ts.map +1 -0
- package/dist/types/api.js +3 -0
- package/dist/types/api.js.map +1 -0
- package/dist/types/biofiles.d.ts +29 -0
- package/dist/types/biofiles.d.ts.map +1 -0
- package/dist/types/biofiles.js +3 -0
- package/dist/types/biofiles.js.map +1 -0
- package/dist/types/credentials.d.ts +17 -0
- package/dist/types/credentials.d.ts.map +1 -0
- package/dist/types/credentials.js +3 -0
- package/dist/types/credentials.js.map +1 -0
- package/package.json +47 -0
- package/test-complete-flow.sh +60 -0
- package/test.vcf +12 -0
- package/test_23andme.txt +12 -0
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
# BioFS Quick Start Guide
|
|
2
|
+
|
|
3
|
+
**BioFS by GenoBank.io** - Command-line interface for managing BioFiles and BioNFTs
|
|
4
|
+
|
|
5
|
+
## 🚀 Quick Commands
|
|
6
|
+
|
|
7
|
+
### Authentication
|
|
8
|
+
```bash
|
|
9
|
+
# Login with Web3 wallet (opens browser)
|
|
10
|
+
biofs login
|
|
11
|
+
|
|
12
|
+
# Check who you are
|
|
13
|
+
biofs whoami
|
|
14
|
+
|
|
15
|
+
# Logout
|
|
16
|
+
biofs logout
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### File Management
|
|
20
|
+
```bash
|
|
21
|
+
# List all your BioFiles
|
|
22
|
+
biofs files
|
|
23
|
+
|
|
24
|
+
# List only VCF files
|
|
25
|
+
biofs files --filter vcf
|
|
26
|
+
|
|
27
|
+
# List files from S3 only
|
|
28
|
+
biofs files --source s3
|
|
29
|
+
|
|
30
|
+
# Get JSON output
|
|
31
|
+
biofs files --json
|
|
32
|
+
|
|
33
|
+
# Force refresh (clear cache)
|
|
34
|
+
biofs files --refresh
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Download Files
|
|
38
|
+
```bash
|
|
39
|
+
# Download by filename
|
|
40
|
+
biofs download my-genome.vcf
|
|
41
|
+
|
|
42
|
+
# Download by BioCID
|
|
43
|
+
biofs download biocid://0x5f5a.../vcf/my-genome.vcf
|
|
44
|
+
|
|
45
|
+
# Download to specific location
|
|
46
|
+
biofs download my-genome.vcf ~/analysis/
|
|
47
|
+
|
|
48
|
+
# Download with no progress bar (quiet mode)
|
|
49
|
+
biofs download my-genome.vcf --quiet
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Upload Files
|
|
53
|
+
```bash
|
|
54
|
+
# Simple upload
|
|
55
|
+
biofs upload ~/data/sample.vcf
|
|
56
|
+
|
|
57
|
+
# Upload and mint as NFT
|
|
58
|
+
biofs upload ~/data/sample.vcf --tokenize
|
|
59
|
+
|
|
60
|
+
# Upload with file type
|
|
61
|
+
biofs upload ~/data/reads.fastq.gz --type fastq
|
|
62
|
+
|
|
63
|
+
# Upload and share with lab
|
|
64
|
+
biofs upload ~/data/report.pdf --share-with 0x1234...5678
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## 📍 BioCID Format
|
|
68
|
+
|
|
69
|
+
BioCID is a universal identifier for genomic files:
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
biocid://<wallet>/<type>/<identifier>
|
|
73
|
+
|
|
74
|
+
Examples:
|
|
75
|
+
biocid://0x5f5a60eaef242c0d51a21c703f520347b96ed19a/vcf/hereditary-cancer-2024.vcf
|
|
76
|
+
biocid://0x5f5a60eaef242c0d51a21c703f520347b96ed19a/fastq/sample-001-R1.fastq.gz
|
|
77
|
+
biocid://0x5f5a60eaef242c0d51a21c703f520347b96ed19a/analysis/alphagenome-job-123
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## 🔐 Credentials
|
|
81
|
+
|
|
82
|
+
Your credentials are stored securely at:
|
|
83
|
+
```
|
|
84
|
+
~/.genobank/credentials.json
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Permissions: `0600` (owner read/write only)
|
|
88
|
+
Expiration: 30 days after authentication
|
|
89
|
+
|
|
90
|
+
## ⚙️ Configuration
|
|
91
|
+
|
|
92
|
+
Edit your preferences at:
|
|
93
|
+
```
|
|
94
|
+
~/.genobank/config.json
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Available settings:
|
|
98
|
+
- `default_download_dir` - Where files are downloaded
|
|
99
|
+
- `api_base_url` - GenoBank API URL
|
|
100
|
+
- `auth_base_url` - Auth service URL
|
|
101
|
+
- `callback_port` - OAuth callback port (default: 44321)
|
|
102
|
+
- `auto_open_browser` - Auto-open browser for auth (default: true)
|
|
103
|
+
- `show_progress` - Show progress bars (default: true)
|
|
104
|
+
|
|
105
|
+
## 🆘 Help
|
|
106
|
+
|
|
107
|
+
Get help for any command:
|
|
108
|
+
```bash
|
|
109
|
+
biofs --help
|
|
110
|
+
biofs login --help
|
|
111
|
+
biofs files --help
|
|
112
|
+
biofs download --help
|
|
113
|
+
biofs upload --help
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## 🔗 Important URLs
|
|
117
|
+
|
|
118
|
+
- **Main API**: https://genobank.app
|
|
119
|
+
- **Auth Service**: https://auth.genobank.app
|
|
120
|
+
- **Documentation**: https://genobank.io
|
|
121
|
+
- **Support**: support@genobank.io
|
|
122
|
+
|
|
123
|
+
## 🛠️ Troubleshooting
|
|
124
|
+
|
|
125
|
+
### "Not authenticated"
|
|
126
|
+
```bash
|
|
127
|
+
biofs logout
|
|
128
|
+
biofs login
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### "BioCID not found"
|
|
132
|
+
```bash
|
|
133
|
+
# Refresh your file list
|
|
134
|
+
biofs files --refresh
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### "Permission denied"
|
|
138
|
+
```bash
|
|
139
|
+
# Check credentials file permissions
|
|
140
|
+
ls -la ~/.genobank/credentials.json
|
|
141
|
+
|
|
142
|
+
# Should be: -rw------- (0600)
|
|
143
|
+
# Fix if needed:
|
|
144
|
+
chmod 0600 ~/.genobank/credentials.json
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Clear cache
|
|
148
|
+
```bash
|
|
149
|
+
rm -rf ~/.genobank/cache/
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## 🎯 Example Workflow
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
# 1. Authenticate
|
|
156
|
+
biofs login
|
|
157
|
+
# ✅ Authenticated as: 0x5f5a...d19a
|
|
158
|
+
|
|
159
|
+
# 2. List your files
|
|
160
|
+
biofs files --filter vcf
|
|
161
|
+
# 📁 Your BioFiles (3 VCF files)
|
|
162
|
+
|
|
163
|
+
# 3. Download a file
|
|
164
|
+
biofs download hereditary-cancer-2024.vcf
|
|
165
|
+
# 📥 Downloading: hereditary-cancer-2024.vcf
|
|
166
|
+
# ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100%
|
|
167
|
+
# ✅ Downloaded to: ~/Downloads/genobank/hereditary-cancer-2024.vcf
|
|
168
|
+
|
|
169
|
+
# 4. Upload a new file as NFT
|
|
170
|
+
biofs upload ~/analysis/variants.vcf --tokenize
|
|
171
|
+
# 📤 Uploading: variants.vcf
|
|
172
|
+
# ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100%
|
|
173
|
+
# 🔗 Minting NFT...
|
|
174
|
+
# ✅ NFT minted: 0x789a...bcde
|
|
175
|
+
# BioCID: biocid://0x5f5a.../vcf/variants.vcf
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## 🚨 Important Notes
|
|
179
|
+
|
|
180
|
+
### Two BioFS Tools
|
|
181
|
+
- **`biofs`** - This CLI tool (Node.js) - File management
|
|
182
|
+
- **`biofs-mount`** - FUSE filesystem (Go) - Mount genomic data
|
|
183
|
+
|
|
184
|
+
### Security
|
|
185
|
+
- Never share your `user_signature` - treat it like a password
|
|
186
|
+
- Credentials auto-expire after 30 days
|
|
187
|
+
- File permissions are enforced (0600 for credentials)
|
|
188
|
+
- All API calls use HTTPS only
|
|
189
|
+
|
|
190
|
+
### File Sources
|
|
191
|
+
BioFS discovers files from:
|
|
192
|
+
- **S3**: GenoBank cloud storage
|
|
193
|
+
- **IPFS**: Decentralized storage
|
|
194
|
+
- **Story Protocol**: Tokenized NFT assets
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
**Version**: 1.0.0
|
|
199
|
+
**Created**: October 4, 2025
|
|
200
|
+
**By**: GenoBank.io Team
|