Akave

https://github.com/akave-ai/akave-docs
Admin
Akave is a decentralized protocol that empowers individuals and businesses with robust storage...
Tokens:56,648
Snippets:948
Trust Score:7.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Linux Node.js install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Installs Node.js on Linux using nvm and verifies the installation.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
\. "$HOME/.nvm/nvm.sh"
nvm install 22
node -v
npm -v
```

--------------------------------

### Mac OS Node.js install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Installs Node.js on macOS using Homebrew and verifies the installation.

```bash
brew install node
node -v
npm -v
```

--------------------------------

### Install Node Version Manager

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to install nvm using Homebrew.

```sh
brew install nvm
```

--------------------------------

### Install Even Node.js Version

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to install an even version of Node.js.

```sh
nvm install v22
```

--------------------------------

### Hardhat npm install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Installs Hardhat as a development dependency in the data-marketplace-policy folder.

```bash
cd data-marketplace-policy
npm install --save-dev hardhat
```

--------------------------------

### Start a local Hardhat network

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

This command starts a local Ethereum network for testing smart contracts.

```sh
npx hardhat node
```

--------------------------------

### Install Go on Ubuntu

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-prerequisites.md

Downloads, extracts, and installs Go on Ubuntu, then adds it to the PATH and verifies the installation.

```bash
wget https://go.dev/dl/go1.23.5.linux-amd64.tar.gz
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.23.5.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin
source ~/.bashrc
go version
```

--------------------------------

### Switch Node.js Version

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to switch to the installed Node.js version.

```sh
nvm use v22
```

--------------------------------

### Ubuntu OS Rclone install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/rclone.md

Installs the latest version of Rclone on Ubuntu using a script.

```bash
sudo -v ; curl https://rclone.org/install.sh | sudo bash
```

```bash
rclone version
```

--------------------------------

### Install Go on macOS (Homebrew)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-prerequisites.md

Installs and upgrades Go using Homebrew, then verifies the installation.

```bash
brew install go
brew upgrade go
go version
```

--------------------------------

### Verify the Installation

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-installation-build.md

Run the 'akavecli version' command to confirm the CLI is installed and accessible.

```bash
akavecli version
```

--------------------------------

### Linux DuckDB install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/duckdb.md

Installs or upgrades DuckDB on Linux using a curl script.

```bash
curl https://install.duckdb.org | sh
```

```bash
duckdb --version
```

--------------------------------

### Mac OS DuckDB install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/duckdb.md

Installs or upgrades DuckDB on Mac OS using Homebrew.

```bash
brew install duckdb
```

```bash
brew upgrade duckdb
```

```bash
duckdb --version
```

--------------------------------

### Clone the policy-guide repository

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Clones the policy-guide repository and navigates into the directory.

```bash
git clone https://github.com/akave-ai/policy-guide.git
cd policy-guide
```

--------------------------------

### Use Profile in Commands

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/introduction/setup.md

Example of an AWS CLI command using the configured 'akave-o3' profile and specifying the endpoint URL to list S3 buckets.

```bash
aws s3api list-buckets \
  --profile akave-o3 \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Mac OS Rclone install example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/rclone.md

Installs or upgrades Rclone on Mac OS using Homebrew.

```bash
brew install rclone
```

```bash
brew upgrade rclone
```

```bash
rclone version
```

--------------------------------

### Environment Variables for Akave Deployment

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Example of environment variables needed for Akave deployment.

```sh
    PRIVATE_KEY="replace-with-your-private-key"
    RPC_URL="akave-rpc-url"
```

--------------------------------

### File-based Key Usage Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/encryption/key-management-options.md

This example shows how to load an encryption key from a secured file into an environment variable for client-side encryption.

```bash
export USER_ENCRYPTION_KEY="$(cat ~/.key/encryption.key)"
```

--------------------------------

### Install MCPHost

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/akave-mcp.md

Command to install MCPHost using Go.

```bash
go install github.com/mark3labs/mcphost@latest
```

--------------------------------

### Build the CLI

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-installation-build.md

Build the Akave CLI binary from the root of the repository.

```bash
make build
```

--------------------------------

### Cloning the Example Repository

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Instructions to clone the urandom repository containing an example S3FS script for Akave O3.

```bash
git clone https://github.com/akave-ai/urandom.git
cd urandom/s3fs
```

--------------------------------

### Create a Bucket (JavaScript)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

JavaScript example to create a new storage bucket using the API request wrapper.

```javascript
apiRequest('POST', '/buckets', { bucketName: 'myBucket' });
```

--------------------------------

### List Buckets (JavaScript)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

JavaScript example to retrieve all existing buckets.

```javascript
apiRequest('GET', '/buckets');
```

--------------------------------

### Listing Buckets Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/akave-mcp.md

Example prompt for an AI model to list buckets using the 'list_buckets' tool.

```bash
# The AI model will automatically use the list_buckets tool
List all my buckets
```

--------------------------------

### Reading a File Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/akave-mcp.md

Example prompt for an AI model to read a file using the 'get_object' tool.

```bash
# The AI model will use the get_object tool
Read the file 'example.md' from bucket 'my-bucket'
```

--------------------------------

### Test Summary Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Example output indicating that all tests for the Hugging Face S3 integration have passed.

```bash
=== Test Summary ===
Example 1: Custom Dataset: ✅ Passed
Example 2: Dataset Transformations: ✅ Passed
Example 3: Transfer MNIST: ✅ Passed
Example 4: Dataset Streaming: ✅ Passed
Example 5: Dataset Versioning: ✅ Passed
Example 6: Dataset Formats: ✅ Passed
Example 7: Create & Save Dataset: ✅ Passed
```

--------------------------------

### Invalid Bucket Name Examples

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-gui/buckets/_index.md

These examples illustrate common mistakes in bucket naming, such as starting with a hyphen, using uppercase letters, including underscores, or being too short.

```text
-test-bucket      (starts with hyphen)
```

```text
MyBucket         (contains uppercase)
```

```text
my_bucket        (contains underscore)
```

```text
ab               (too short, under 3 characters)
```

--------------------------------

### Run the test suite with verbose output

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

This command runs the test suite with more detailed output.

```sh
npx hardhat test --verbose
```

--------------------------------

### Uploading a File Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/akave-mcp.md

Example prompt for an AI model to upload a file using the 'put_object' tool.

```bash
# The AI model will use the put_object tool
Upload the content 'Hello World' to 'greeting.txt' in bucket 'my-bucket'
```

--------------------------------

### Clone the Repository

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-installation-build.md

Clone the Akave SDK repository and navigate to the directory.

```bash
git clone https://github.com/akave-ai/akavesdk.git
cd akavesdk
```

--------------------------------

### AWS Credentials File Entry

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/introduction/setup.md

Example INI format for adding a new profile to the AWS credentials file, including access key, secret key, and the Akave O3 endpoint URL.

```ini
[akave-o3]
aws_access_key_id = <your_access_key>
aws_secret_access_key = <your_secret_key>
endpoint_url = <YOUR_ENDPOINT_URL>
```

--------------------------------

### Verify Hugging Face Datasets Installation

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Loads a sample dataset to verify the installation and functionality of the Hugging Face datasets library.

```python
from datasets import load_dataset
print(load_dataset('rajpurkar/squad', split='train')[0])
```

--------------------------------

### Example sse.json

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/encryption/server-side-client-side-encryption.md

Example JSON configuration file for enabling server-side encryption.

```json
{
  "Rules": [
    {
      "ApplyServerSideEncryptionByDefault": {
        "SSEAlgorithm": "AES256"
      }
    }
  ]
}
```

--------------------------------

### Make the Binary Available System-Wide (Unix-Based Systems)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-installation-build.md

Move the built CLI binary to a directory on your system's PATH for global access.

```bash
sudo mv bin/akavecli /usr/local/bin/
```

```bash
sudo mv bin/akavecli /usr/bin/
```

--------------------------------

### List Files in a Bucket (JavaScript)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

JavaScript example to retrieve a list of files within a bucket.

```javascript
apiRequest('GET', '/buckets/myBucket/files');
```

--------------------------------

### Verify S3FS Installation

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Checks the installation details of the s3fs library.

```bash
pip show s3fs
```

--------------------------------

### Verify Pip Installation

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Command to check if pip is installed.

```bash
pip --version
```

--------------------------------

### MCP Configuration File Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/akave-mcp.md

Example JSON configuration for the Akave MCP server, to be saved as 'mcp.json'.

```json
{
  "mcpServers": {
    "akave": {
      "command": "npx",
      "args": [
        "-y",
        "akave-mcp-js"
      ],
      "env": {
        "AKAVE_ACCESS_KEY_ID": "your_access_key",
        "AKAVE_SECRET_ACCESS_KEY": "your_secret_key",
        "AKAVE_ENDPOINT_URL": "your_endpoint_url"
      }
    }
  }
}
```

--------------------------------

### Get File Info

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

Fetches metadata about a specific file using JavaScript and curl.

```javascript
apiRequest('GET', '/buckets/myBucket/files/myFile.txt');
```

```bash
curl -X GET http://localhost:8000/buckets/myBucket/files/myFile.txt
```

--------------------------------

### View Bucket Details (JavaScript)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

JavaScript example to retrieve details of a specific bucket.

```javascript
apiRequest('GET', '/buckets/myBucket');
```

--------------------------------

### Command to find process using a port

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to identify which process is using a specific network port.

```bash
lsof -i :8545
```

--------------------------------

### Expected Deployment Output

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

This is an example of the expected output when the MarketplacePolicy contract is successfully deployed.

```sh
Hardhat Ignition 🚀

Deploying [ MarketplacePolicyModule ]

Batch #1
  Executed MarketplacePolicyModule#MarketplacePolicy
  Executed call: initialize()
  Executed call: setSubscriptionPrice(1 ETH)

[ MarketplacePolicyModule ] successfully deployed 🚀

Deployed Addresses

MarketplacePolicyModule#MarketplacePolicy - 0x5FbDB...
```

--------------------------------

### Install Hugging Face Datasets and S3FS

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Installs the Hugging Face datasets library and s3fs for S3 compatibility.

```bash
pip install s3fs datasets
```

--------------------------------

### Example Response with eCID Metadata

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

An example JSON response from the head-object command, showing the Network-Root-Cid in the Metadata section.

```json
{
    "LastModified": "2024-05-15T00:00:00+00:00",
    "ContentLength": 2194339,
    "ChecksumType": "FULL_OBJECT",
    "ETag": "\"/AUFzg+DN6yA3d95WCR31g==\"",
    "MissingMeta": 0,
    "VersionId": "V1",
    "ContentType": "image/png",
    "ServerSideEncryption": "AES256",
    "Metadata": {
        "Network-File-Name": "4c8da9604c2cea1085d41b446e07c335deae60636feaf4d0fcf6d67cbadabd013ae209ab478f0cde06c7cb03fe",
        "Network-Processed": "100",
        "Network-Root-Cid": "bafybeicun4bwqcby46mcxicctyob6vjd4lid74k3c4lzfaifl56sghrt3q",
        "Network-State": "done"
    },
    "StorageClass": "default",
    "PartsCount": 0
}
```

--------------------------------

### Run the test suite

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

This command runs the test suite to validate the functionality of the deployed contract.

```sh
npx hardhat test
```

--------------------------------

### Valid Bucket Name Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-gui/buckets/_index.md

Bucket names must be globally unique, 3-63 characters long, use only lowercase letters, numbers, or hyphens, and start and end with a letter or number.

```text
test-project-alpha
```

--------------------------------

### Example of versioned file structure after download

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-troubleshooting.md

Demonstrates how a versioned file might appear as a directory with versioned files inside after being downloaded by akavecli.

```bash
cd file.txt
ls
V1
```

--------------------------------

### Allow All Origins (Public Read)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/cors/cors-examples.md

A CORS configuration that allows all origins to perform GET requests, suitable for public read access.

```json
{
  "CORSRules": [
    {
      "AllowedHeaders": ["*"],
      "AllowedMethods": ["GET"],
      "AllowedOrigins": ["*"],
      "MaxAgeSeconds": 3000
    }
  ]
}
```

--------------------------------

### Expected Test Output

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

This is an example of the expected output when all tests pass successfully.

```sh
   MarketplacePolicy
       ✔ Should deploy and check initial state
       ✔ Should allow owner to set subscription price
       ✔ Should allow users to subscribe, verification returns true for subscribed users
       ✔ Should revert if once subscribed user lost access due to subscription expiration
       ✔ Subscription can be prolonged
       ✔ Non-subscribed users do not have access


     6 passing
```

--------------------------------

### Set Subscription Price (Akave Network)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to set the subscription price on the Akave Network.

```sh
npx hardhat run setPrice.ts --network akaveNetwork
```

--------------------------------

### Allow Specific Origin (e.g. frontend site)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/cors/cors-examples.md

A CORS configuration that allows a specific origin (e.g., a frontend website) to perform GET and PUT requests, exposing the ETag header.

```json
{
  "CORSRules": [
    {
      "AllowedHeaders": ["Authorization"],
      "AllowedMethods": ["GET", "PUT"],
      "AllowedOrigins": ["https://frontend.example.com"],
      "ExposeHeaders": ["ETag"],
      "MaxAgeSeconds": 600
    }
  ]
}
```

--------------------------------

### Install S3FS Library

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Command to install the s3fs Python library using pip.

```bash
pip install s3fs
```

--------------------------------

### Delete a Bucket (JavaScript)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

JavaScript example to delete a specific bucket.

```javascript
apiRequest('DELETE', '/buckets/myBucket');
```

--------------------------------

### Create a Bucket (curl)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

curl command to create a new storage bucket.

```bash
curl -X POST http://localhost:8000/buckets -H "Content-Type: application/json" -d '{"bucketName": "myBucket"}'
```

--------------------------------

### Deploy Marketplace Policy Contract

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to deploy the Marketplace Policy contract locally.

```sh
npx hardhat ignition deploy ./ignition/modules/MarketplacePolicy.ts --network akaveNetwork
```

--------------------------------

### Installing Dependencies

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Command to install the necessary Python packages (s3fs and pandas) for the S3FS integration.

```bash
pip install s3fs pandas
```

--------------------------------

### Set Subscription Price

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to set the subscription price for your deployed contract.

```sh
npx hardhat run setPrice.ts --network localhost
```

--------------------------------

### Start MCPHost with Ollama

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/akave-mcp.md

Commands to start MCPHost with an Ollama model, showing options for default and custom config file locations, and debugging.

```bash
# Using default config location
mcphost -m ollama:mistral

# Or specify a custom config file
mcphost -m ollama:mistral --config /path/to/your/mcp.json

# For debugging
mcphost --debug -m ollama:mistral --config /path/to/your/mcp.json
```

--------------------------------

### Get File Info

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

Fetches metadata about a file.

```bash
akavecli file info <bucket-name> <file-name> \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### Command to kill a process

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Command to terminate a process using its Process ID (PID).

```bash
kill -9 12345
```

--------------------------------

### Install S3FS Fuse on Linux

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Command to install s3fs on Debian/Ubuntu systems.

```bash
sudo apt install s3fs
```

--------------------------------

### Install httpfs extension

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/duckdb.md

Installs the httpfs extension in DuckDB, required for S3 access.

```sql
INSTALL httpfs;
```

--------------------------------

### Authentication using .env Files

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of using a .env file to load Akave credentials and initializing S3FS.

```text
AKAVE_ACCESS_KEY=your_access_key_here
AKAVE_SECRET_KEY=your_secret_key_here
```

```python
import os
from dotenv import load_dotenv

# Load environment variables from .env file
load_dotenv()

fs = s3fs.S3FileSystem(
    key=os.environ.get("AKAVE_ACCESS_KEY"),
    secret=os.environ.get("AKAVE_SECRET_KEY"),
    endpoint_url="<YOUR_ENDPOINT_URL>",
    client_kwargs={"region_name": "akave-network"}
)
```

--------------------------------

### Edit Credentials File

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/introduction/setup.md

Command to open the AWS credentials file in the nano text editor for manual configuration.

```bash
nano ~/.aws/credentials
```

--------------------------------

### Test: Prolong Subscription (First Time Increase)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Modify the first time increase in the test to be just less than 3x the SUBSCRIPTION_DURATION. Example uses 8 days for a 3-day subscription.

```javascript
await time.increase(60 * 60 * 24 * 8);
```

--------------------------------

### Install S3FS Fuse on MacOS

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Commands to install macFUSE and s3fs-mac on macOS using Homebrew.

```bash
brew install --cask macfuse
brew install gromgit/fuse/s3fs-mac
```

--------------------------------

### Deploy the MarketplacePolicy contract

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

This command deploys the MarketplacePolicy contract to the local Hardhat network using Hardhat Ignition.

```sh
npx hardhat ignition deploy ./ignition/modules/MarketplacePolicy.ts --network localhost
```

--------------------------------

### Authentication using Environment Variables

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of setting Akave credentials via environment variables and initializing S3FS.

```bash
export AKAVE_ACCESS_KEY=your_access_key_here
export AKAVE_SECRET_KEY=your_secret_key_here
```

```python
import os

access_key = os.environ.get("AKAVE_ACCESS_KEY")
secret_key = os.environ.get("AKAVE_SECRET_KEY")

fs = s3fs.S3FileSystem(
    key=access_key,
    secret=secret_key,
    endpoint_url="<YOUR_ENDPOINT_URL>",
    client_kwargs={"region_name": "akave-network"}
)
```

--------------------------------

### Akave O3 Configuration - Name your remote

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/rclone.md

Example of naming the remote configuration in Rclone.

```bash
Akave
```

--------------------------------

### Test: Prolong Subscription (Second Time Increase)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Modify the second time increase in the test to ensure access expires after multiple subscription durations. Example uses 2 days.

```javascript
await time.increase(60 * 60 * 24 * 2); // 2 days
```

--------------------------------

### Running All Tests on a Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example command to execute all tests on a specified bucket using the s3fs_test.py script.

```bash
python s3fs_test.py my-bucket
```

--------------------------------

### Enable Debugging Options

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of s3fs-fuse mounting options for enabling debugging.

```bash
-o dbglevel=info -f
```

--------------------------------

### List Buckets (curl)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

curl command to retrieve all existing buckets.

```bash
curl -X GET http://localhost:8000/buckets
```

--------------------------------

### Authentication using AWS CLI Profile

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of initializing S3FS using an AWS CLI profile.

```python
fs = s3fs.S3FileSystem(
    profile="akave-o3",
    endpoint_url="<YOUR_ENDPOINT_URL>",
    client_kwargs={"region_name": "akave-network"}
)
```

--------------------------------

### Download a File

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

Downloads a file from a bucket using JavaScript and curl.

```javascript
async function downloadFile(bucketName, fileName, outputDir) {
  const fs = require('fs');
  try {
    const response = await axios.get(`${API_BASE_URL}/buckets/${bucketName}/files/${fileName}/download`, {
      responseType: 'blob',
    });
    console.log(`File downloaded: ${fileName}`);
    fs.writeFileSync(`./${outputDir}/${fileName}`, response.data);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}
```

```bash
curl -X GET http://localhost:8000/buckets/myBucket/files/myFile.txt/download -o myFile.txt
```

--------------------------------

### Write DataFrame with Partitioning to Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of writing a Spark DataFrame with partitioning to an Akave bucket.

```python
df.write.partitionBy("year", "month").parquet("s3a://bucket-name/partitioned-data/")
```

--------------------------------

### Configure AWS CLI Profile

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/introduction/setup.md

Command to initiate the configuration of a new AWS CLI profile named 'akave-o3'. It prompts for access key ID, secret access key, default region, and output format.

```bash
aws configure --profile akave-o3
```

--------------------------------

### Access Denied Error Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/authentication-and-access/bucket-policies-and-acls.md

Example error response when attempting to access an object after the ACL policy has been deleted.

```xml
<Error>
<Code>AccessDenied</Code>
<Message>Access Denied</Message>
<Reason>Object ACL not found</Reason>
<Resource/>
<RequestId/>
<HostId/>
</Error>
```

--------------------------------

### Akave Credentials File Configuration

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example configuration for the AWS credentials file to authenticate with Akave O3.

```ini
[akave-o3]
aws_access_key_id = your_access_key_id
aws_secret_access_key = your_secret_access_key
endpoint_url = <YOUR_ENDPOINT_URL>
```

--------------------------------

### Use Cache Option

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of s3fs-fuse mounting option to specify a cache directory.

```bash
-o use_cache=/path/to/cache
```

--------------------------------

### ACL Policy JSON Example

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/authentication-and-access/bucket-policies-and-acls.md

An example JSON file defining an ACL policy to allow public read access to a bucket.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": "*",
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::my-akave-bucket/*"
        }
    ]
}
```

--------------------------------

### Pull the Docker Image

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

Command to pull the latest Akave Link Docker image.

```bash
docker pull akave/akavelink:latest
```

--------------------------------

### S3 Copy Command with Akave O3 Profile

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/troubleshooting/common-issues-and-solutions.md

Example of using the aws s3 cp command with a specified Akave O3 profile and endpoint URL.

```bash
aws s3 cp ./file.txt s3://my-akave-bucket/ \
  --profile akave-o3 \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Enable Caching

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of enabling caching for a DataFrame in Databricks.

```python
df.cache()
```

--------------------------------

### Edit File in Place

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of editing a file directly within the mounted Akave bucket using nano.

```bash
nano ~/akave-mount/notes/todo.txt
```

--------------------------------

### Write DataFrame as Parquet to Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of writing a Spark DataFrame as a Parquet file to an Akave bucket.

```python
df.write.mode("overwrite").parquet("s3a://bucket-name/path/to/output/")
```

--------------------------------

### Read Parquet File from Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of reading a Parquet file from an Akave bucket using Spark.

```python
df = spark.read.parquet("s3a://bucket-name/path/to/file.parquet")
df.show()
```

--------------------------------

### List Files in a Bucket (curl)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

curl command to retrieve a list of files within a bucket.

```bash
curl -X GET http://localhost:8000/buckets/myBucket/files
```

--------------------------------

### Read CSV File from Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of reading a CSV file from an Akave bucket using Spark.

```python
df = spark.read.csv("s3a://bucket-name/path/to/file.csv", header=True, inferSchema=True)
df.show()
```

--------------------------------

### Parallel Upload Option

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of s3fs-fuse mounting option to control parallel upload threads.

```bash
-o parallel_count=1
```

--------------------------------

### Run the Akave Link Docker Container

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

Command to run the Akave Link Docker container with specified environment variables for node address and private key.

```bash
docker run -d \
  -p 8000:3000 \
  -e NODE_ADDRESS="public_node_address" \
  -e PRIVATE_KEY="your_private_key" \
  akave/akavelink:latest
```

--------------------------------

### Multi-Request Maximum Option

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of s3fs-fuse mounting option to control maximum parallel requests.

```bash
-o multireq_max=1
```

--------------------------------

### View Bucket Details (curl)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

curl command to retrieve details of a specific bucket.

```bash
curl -X GET http://localhost:8000/buckets/myBucket
```

--------------------------------

### Upload a File

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

Uploads a file to a bucket using JavaScript with FormData and curl.

```javascript
const FormData = require('form-data');
const fs = require('fs');

async function uploadFile(bucketName, filePath) {
  const form = new FormData();
  form.append('file', fs.createReadStream(filePath));
  
  try {
    const response = await axios.post(`${API_BASE_URL}/buckets/${bucketName}/files`, form, {
      headers: form.getHeaders(),
    });
    console.log(response.data);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}

uploadFile('myBucket', './path/to/file.txt');
```

```bash
curl -X POST http://localhost:8000/buckets/myBucket/files -F file=@/path/to/file.txt
```

--------------------------------

### Multipart Upload Parts JSON Structure

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/multipart-uploads/initiate-upload-complete-abort.md

Example JSON structure required for the `complete-multipart-upload` command, listing the ETag and PartNumber for each uploaded part.

```json
{
  "Parts": [
    {
      "ETag": "\"etag-part1\"",
      "PartNumber": 1
    },
    {
      "ETag": "\"etag-part2\"",
      "PartNumber": 2
    }
  ]
}
```

--------------------------------

### Write DataFrame as CSV to Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of writing a Spark DataFrame as a CSV file to an Akave bucket.

```python
df.write.mode("overwrite").csv("s3a://bucket-name/path/to/output/", header=True)
```

--------------------------------

### Akave O3 Configuration - Get AWS credentials from runtime

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/rclone.md

Configuration option for fetching AWS credentials from runtime.

```bash
false
```

--------------------------------

### Read Parquet with Pandas

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of reading a parquet file directly from Akave storage into a pandas DataFrame.

```python
df = pd.read_parquet(fs.open("your-bucket-name/data.parquet"))
```

--------------------------------

### Read CSV with Pandas

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of reading a CSV file directly from Akave storage into a pandas DataFrame.

```python
df = pd.read_csv(fs.open("your-bucket-name/data.csv"))
```

--------------------------------

### Read Multiple Parquet Files from Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of reading multiple Parquet files from an Akave bucket using Spark.

```python
df = spark.read.parquet("s3a://bucket-name/path/to/data/*.parquet")
df.show()
```

--------------------------------

### Delete a Bucket (curl)

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

curl command to delete a specific bucket.

```bash
curl -X DELETE http://localhost:8000/buckets/myBucket
```

--------------------------------

### Create Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

Creates a new bucket on the Akave network.

```bash
akavecli bucket create <bucket-name> \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### Test: Subscription Expiration

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Update test to check if a user loses access due to subscription expiration. Adjust time increase to represent 4 days.

```javascript
await time.increase(60 * 60 * 24 * 4);
```

--------------------------------

### MarketplacePolicy.sol Subscription Duration

Source: https://github.com/akave-ai/akave-docs/blob/master/content/smart-contracts/data-marketplace-example.md

Defines the default length of a data subscription period in the MarketplacePolicy.sol contract.

```solidity
uint256 constant SUBSCRIPTION_DURATION = 30 days;
```

--------------------------------

### Read JSON Data from Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of reading JSON data from an Akave bucket using Spark.

```python
df = spark.read.json("s3a://bucket-name/path/to/file.json")
df.show()
```

--------------------------------

### Write DataFrame to Parquet with Pandas

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of writing a pandas DataFrame to a parquet file in Akave O3 storage.

```python
df.to_parquet(fs.open("your-bucket-name/processed-data.parquet", "wb"))
```

--------------------------------

### Write DataFrame as Delta Table to Akave

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Example of writing a Spark DataFrame as a Delta table to an Akave bucket.

```python
df.write.format("delta").mode("overwrite").save("s3a://bucket-name/path/to/delta-table/")
```

--------------------------------

### S3 Put Object with Explicit Checksum

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/troubleshooting/common-issues-and-solutions.md

Example of using the aws s3api put-object command with an explicitly supported checksum algorithm.

```bash
aws s3api put-object \
  --bucket my-akave-bucket \
  --key example.txt \
  --body ./example.txt \
  --checksum-algorithm CRC32 \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Wallet Commands Help

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Shows available wallet commands in the Akave CLI.

```bash
akavecli wallet --help
```

--------------------------------

### Download Versioned File using Akave CLI

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/troubleshooting/common-issues-and-solutions.md

Step 2: Perform the download using the akavecli, specifying bucket name, file key, destination, node address, and private key.

```bash
akavecli ipc file download <bucket-name> file.txt/null . --node-address=connect.akave.ai:5500 --private-key "your-private-key"
```

--------------------------------

### Create Directory for Versioned File Download

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/troubleshooting/common-issues-and-solutions.md

Step 1: Create a directory with the same name as the file to handle versioned downloads correctly.

```bash
mkdir file.txt
```

--------------------------------

### Install Maven Hadoop Packages

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/databricks.md

Add the specified Hadoop packages as Maven coordinates to your Databricks compute cluster's libraries.

```bash
org.apache.hadoop:hadoop-aws:3.3.6
```

```bash
org.apache.hadoop:hadoop-common:3.3.6
```

--------------------------------

### Allow Web Uploads from Browser

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/cors/cors-examples.md

A CORS configuration that allows a specific origin to perform POST and PUT requests, commonly used for browser-based uploads, and exposes the ETag header.

```json
{
  "CORSRules": [
    {
      "AllowedHeaders": ["*"],
      "AllowedMethods": ["POST", "PUT", "GET"],
      "AllowedOrigins": ["https://app.example.com"],
      "ExposeHeaders": ["ETag"],
      "MaxAgeSeconds": 3600
    }
  ]
}
```

--------------------------------

### Initialize HuggingFaceS3 client

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Initializing the HuggingFaceS3 client for interacting with Hugging Face datasets on Akave O3 storage.

```python
from huggingface_s3 import HuggingFaceS3

hf_s3 = HuggingFaceS3()
```

--------------------------------

### View Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

Shows details for a specific bucket.

```bash
akavecli bucket view <bucket-name> \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### Environment variables for Akave O3 storage

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Configuration of environment variables for Akave O3 storage by duplicating and filling the .env.example file.

```bash
AKAVE_ACCESS_KEY=your_access_key
AKAVE_SECRET_KEY=your_secret_key
AKAVE_ENDPOINT_URL=https://o3-rc2.akave.xyz
AKAVE_BUCKET_NAME=your-bucket-name
```

--------------------------------

### Use Wallet with Bucket Command

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Creates a bucket using a specified wallet account.

```bash
akavecli bucket create mybucket --account <wallet-name>
```

--------------------------------

### Create a New Wallet

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Creates a new wallet, stores it in the keystore, and assigns it a name.

```bash
akavecli wallet create
```

--------------------------------

### Workaround Step 2: Download the file into the created directory

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-troubleshooting.md

Command to download a versioned file into a directory, preserving the directory structure.

```bash
akavecli file download <bucket-name> file.txt/null . \
    --account <wallet-name> \
    --node-address connect.akave.ai:5500
```

--------------------------------

### List Buckets using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/bucket-management/create-list-delete-buckets.md

Command to list all existing buckets using the higher-level `aws s3` tool.

```bash
aws s3 ls \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### List Buckets using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/bucket-management/create-list-delete-buckets.md

Command to list all existing buckets using the `aws s3api` tool.

```bash
aws s3api list-buckets \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Create a Bucket using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/bucket-management/create-list-delete-buckets.md

Command to create a new bucket using the higher-level `aws s3` tool.

```bash
aws s3 mb s3://my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Create Private Key File

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Creates a secure directory and file to store the private key.

```bash
mkdir -p ~/.key
echo "your-private-key-content" > ~/.key/user.akvf.key
chmod 600 ~/.key/user.akvf.key
```

--------------------------------

### List Files in a Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

List all the files in specified bucket

```bash
akavecli file list <bucket-name> \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### Confirmed ACL Policy Response

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/authentication-and-access/bucket-policies-and-acls.md

Example response when an ACL policy is successfully retrieved.

```json
{
    "Policy": "{\"policy\":{\"statement\":[{\"effect\":\"Allow\",\"principal\":\"*\",\"action\":\"s3:GetObject\",\"resource\":\"arn:aws:s3:::my-akave-bucket/*\"}]},\"version\":\"2012-10-17\"}"
}
```

--------------------------------

### Check AWS CLI Version

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/troubleshooting/common-issues-and-solutions.md

Command to check the currently installed AWS CLI version.

```bash
aws --version
```

--------------------------------

### Use Wallet in Network Command

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Creates a bucket using a specified wallet account and node address.

```bash
akavecli bucket create mybucket \
      --account mywallet \
      --node-address connect.akave.ai:5500
```

--------------------------------

### Write DataFrame to CSV with Pandas

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Example of writing a pandas DataFrame to a CSV file in Akave O3 storage.

```python
df.to_csv(fs.open("your-bucket-name/processed-data.csv", "w"))
```

--------------------------------

### Create a Bucket using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/bucket-management/create-list-delete-buckets.md

Command to create a new bucket using the `aws s3api` tool.

```bash
aws s3api create-bucket \
  --bucket my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Use Private Key File in Command

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Uses the private key from a file in an Akave CLI command.

```bash
akavecli bucket create mybucket \
    --private-key "$(cat ~/.key/user.akvf.key)" \
    --node-address connect.akave.ai:5500
```

--------------------------------

### List Buckets

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

Lists all buckets associated with the selected account.

```bash
akavecli bucket list \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### List Wallets

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Displays all wallets stored in the keystore.

```bash
akavecli wallet list
```

--------------------------------

### Create Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/snowflake.md

Create a new S3-compatible bucket in Akave using the AWS CLI.

```bash
aws s3 mb s3://my-snowflake-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Initiate Multipart Upload with `aws s3api`

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/multipart-uploads/initiate-upload-complete-abort.md

Initiates a multipart upload and returns an UploadId that must be used in subsequent steps.

```bash
aws s3api create-multipart-upload \
  --bucket my-akave-bucket \
  --key largefile.zip \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Get File Metadata

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Python code to retrieve metadata (like size and last modified date) for a file.

```python
info = fs.info("your-bucket-name/myfile.txt")
print(f"File size: {info['size']} bytes")
print(f"Last modified: {info['LastModified']}")
```

--------------------------------

### Clone urandom repository and navigate to huggingface directory

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Cloning the urandom repository and navigating to the huggingface directory to access helper scripts.

```bash
git clone https://github.com/akave-ai/urandom.git
cd urandom/huggingface
```

--------------------------------

### Generate a Presigned URL for Download

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/presigned-urls/generate-and-use-presigned-urls.md

This command generates a URL valid for 1 hour (3600 seconds) to download the specified file from an Akave O3 bucket.

```bash
aws s3 presign s3://my-akave-bucket/myfile.txt \
  --expires-in 3600 \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Create Mount Directory

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Command to create a directory where an Akave bucket will be mounted.

```bash
mkdir -p ~/akave-mount
```

--------------------------------

### Import a Private Key

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Imports a wallet using a private key, creating a new wallet entry.

```bash
akavecli wallet import <wallet-name> <private-key>
```

--------------------------------

### List Objects using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Lists all objects within a specified Akave O3 bucket using the aws s3 ls command.

```bash
aws s3 ls s3://my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Verify Deleted ACL Policy Response

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/authentication-and-access/bucket-policies-and-acls.md

Example response when an ACL policy has been deleted (empty policy).

```json
{
    "Policy": "{\"policy\":{\"statement\":null,\"version\":\"\"}}"
}
```

--------------------------------

### Use Environment Variable in Command

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Uses the private key from an environment variable in an Akave CLI command.

```bash
akavecli bucket create mybucket \
    --private-key "$AKAVE_PRIVATE_KEY" \
    --node-address connect.akave.ai:5500
```

--------------------------------

### Configure Multipart Upload Threshold

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Sets the multipart upload threshold to 100MB for Akave O3 to optimize upload performance for large files.

```bash
aws configure set default.s3.multipart_threshold 100MB
```

--------------------------------

### Upload Parts with `aws s3api`

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/multipart-uploads/initiate-upload-complete-abort.md

Uploads a specific part of the file. This command should be repeated for each part, incrementing the `--part-number`.

```bash
aws s3api upload-part \
  --bucket my-akave-bucket \
  --key largefile.zip \
  --part-number 1 \
  --body part1.zip \
  --upload-id <UploadId> \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### List Incomplete Multipart Uploads

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/multipart-uploads/best-practices-for-large-files.md

Periodically list all incomplete multipart uploads to identify and clean up stale uploads that are consuming storage.

```bash
aws s3api list-multipart-uploads --bucket your-bucket
```

--------------------------------

### Run Tests

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Command to execute the test script for the Hugging Face S3 integration.

```bash
python test_huggingface_s3.py
```

--------------------------------

### Upload File

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

Uploads a file from your local filesystem into the bucket.

```bash
akavecli file upload <bucket-name> <file-path> \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### Verify Object Upload with Head Object

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/multipart-uploads/best-practices-for-large-files.md

After completing a multipart upload, use the head-object command to confirm the file's existence and retrieve its metadata.

```bash
aws s3api head-object --bucket your-bucket --key large_file.dat
```

--------------------------------

### Download an Object using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Downloads an object from an Akave O3 bucket to a local file using the aws s3 cp command.

```bash
aws s3 cp s3://my-akave-bucket/myfile.txt ./downloaded-myfile.txt \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### List Objects using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Lists all objects within a specified Akave O3 bucket using the aws s3api list-objects command.

```bash
aws s3api list-objects \
  --bucket my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### JavaScript API Request Wrapper

Source: https://github.com/akave-ai/akave-docs/blob/master/content/js-docker-example-code.md

A JavaScript function using axios to make requests to the Akave API, handling responses and errors.

```javascript
const axios = require('axios');

const API_BASE_URL = 'http://localhost:8000';

async function apiRequest(method, endpoint, data = null) {
  try {
    const response = await axios({
      method,
      url: `${API_BASE_URL}${endpoint}`,
      data,
    });
    console.log(response.data);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}
```

--------------------------------

### Download File

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-bucket-file.md

Downloads a file from a bucket.

```bash
akavecli file download <bucket-name> <file-name> <destination-folder> \
  --account <wallet-name> \
  --node-address connect.akave.ai:5500
```

--------------------------------

### Upload an Object using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Uploads a local file to an Akave O3 bucket using the simpler aws s3 cp command.

```bash
aws s3 cp ./myfile.txt s3://my-akave-bucket/myfile.txt \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Download an Object using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Downloads an object from an Akave O3 bucket to a local file using the aws s3api get-object command.

```bash
aws s3api get-object \
  --bucket my-akave-bucket \
  --key myfile.txt \
  ./downloaded-myfile.txt \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### List available buckets

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Using the list_buckets() method to retrieve all S3 buckets accessible with the provided credentials.

```python
buckets = hf_s3.list_buckets()
print(buckets)
```

--------------------------------

### Error Handling with S3FS

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Demonstrates how to handle potential errors like NoSuchKey and AccessDenied when interacting with S3-compatible storage using S3FS.

```python
import botocore.exceptions

try:
    # Attempt to access a file
    with fs.open("your-bucket-name/may-not-exist.txt", "rb") as f:
        content = f.read()
except botocore.exceptions.ClientError as e:
    if e.response["Error"]["Code"] == "NoSuchKey":
        print("The file does not exist")
    elif e.response["Error"]["Code"] == "AccessDenied":
        print("Access denied - check permissions")
    else:
        print(f"Error occurred: {e}")
```

--------------------------------

### Total Size for All Objects in a Bucket using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Calculates and displays the total size of all objects in an Akave O3 bucket using the aws s3 ls command with recursive, human-readable, and summarize options.

```bash
aws s3 ls s3://my-akave-bucket \
--recursive --human-readable --summarize \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Retrieve Initial Admin Password

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/acronis.md

Command to retrieve the initial administrator password from the gateway instance.

```bash
cat /.initial-admin-password
```

--------------------------------

### Upload an Object using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/upload-download-delete-objects.md

Uploads a local file to an Akave O3 bucket using the aws s3api put-object command.

```bash
aws s3api put-object \
  --bucket my-akave-bucket \
  --key myfile.txt \
  --body ./myfile.txt \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Use a Presigned URL to Download

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/presigned-urls/generate-and-use-presigned-urls.md

This command demonstrates how to use a generated presigned URL to download a file using curl.

```bash
curl "<YOUR_ENDPOINT_URL>/my-akave-bucket/myfile.txt?...signature..."
```

--------------------------------

### Batch Operations for Performance

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Illustrates how to upload multiple files efficiently using a batch operation approach with S3FS.

```python
files_to_upload = [
    ("local1.txt", "your-bucket-name/remote1.txt"),
    ("local2.txt", "your-bucket-name/remote2.txt"),
    ("local3.txt", "your-bucket-name/remote3.txt")
]

for local, remote in files_to_upload:
    fs.put(local, remote)
```

--------------------------------

### Complete Multipart Upload with `aws s3api`

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/multipart-uploads/initiate-upload-complete-abort.md

Completes the multipart upload after all parts have been uploaded. Requires a JSON structure detailing the uploaded parts.

```bash
aws s3api complete-multipart-upload \
  --bucket my-akave-bucket \
  --key largefile.zip \
  --upload-id <UploadId> \
  --multipart-upload file://parts.json \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### List Object Versions using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/object-versioning-and-copying.md

Lists all versions of objects within a specified bucket using the AWS CLI s3api command.

```bash
aws s3api list-object-versions \
  --bucket my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Move Downloaded File and Rename

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/troubleshooting/common-issues-and-solutions.md

Steps 3-6: Navigate into the created directory, move the downloaded versioned file to a temporary name, return to the parent directory, remove the temporary directory, and rename the file back to its original name.

```bash
cd file.txt
mv * ../file.tmp
cd ..
rmdir file.txt
mv file.tmp file.txt
```

--------------------------------

### Connect to the Gateway Instance via SSH

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/acronis.md

Command to connect to the Acronis Gateway instance using SSH with a specified key file.

```bash
chmod 400 name.pem
ssh -i "name.pem" cloud-user@ec2-54-237-90-228.compute-1.amazonaws.com
```

--------------------------------

### Create Snowflake Stage

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/snowflake.md

Create an external stage in Snowflake pointing to your Akave bucket.

```sql
CREATE STAGE my_akave_stage
  URL = 's3compat://my-snowflake-bucket/'
  ENDPOINT = '<YOUR_ENDPOINT_URL>'
  CREDENTIALS = (AWS_KEY_ID = '1a2b3c...' AWS_SECRET_KEY = '4x5y6z...')
  DIRECTORY = ( ENABLE = true );
```

--------------------------------

### Export a Private Key

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-sdk-cli/akavecli-wallet.md

Exports the private key for a specified wallet.

```bash
akavecli wallet export-key <wallet-name>
```

--------------------------------

### Verify Object Lock Configuration

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/object-lock.md

This command retrieves the Object Lock configuration for a bucket.

```bash
aws s3api get-object-lock-configuration \
  --bucket my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### List Object Versions using aws s3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/object-management/object-versioning-and-copying.md

Lists objects recursively in a bucket using the AWS CLI s3 command. Note: This command shows only the latest versions.

```bash
aws s3 ls s3://my-akave-bucket --recursive --human-readable \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Upload Object

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/snowflake.md

Upload a file to your newly created Akave bucket using the AWS CLI.

```bash
aws s3 cp ./myfile.txt s3://my-snowflake-bucket/myfile.txt \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Open DuckDB CLI

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/duckdb.md

Opens the DuckDB command-line interface.

```bash
duckdb
```

--------------------------------

### List Files in Mounted Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Standard Linux command to list files and their sizes within the mounted Akave bucket.

```bash
ls -l ~/akave-mount
```

--------------------------------

### Download File from Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Standard Linux command to copy a file from the mounted Akave bucket to the local directory.

```bash
cp ~/akave-mount/myfile.txt ./
```

--------------------------------

### Verify Backup Data in Akave Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/acronis.md

This command verifies that backup data has been successfully written to the Akave bucket via the gateway.

```bash
aws s3 ls s3://your-bucket-name/ \
  --endpoint-url <YOUR_ENDPOINT_URL> \
  --recursive
```

--------------------------------

### Copy Local File to Bucket

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/s3fs.md

Standard Linux command to copy a local file into the mounted Akave bucket.

```bash
cp myfile.txt ~/akave-mount/
```

--------------------------------

### Delete a Bucket using aws s3api

Source: https://github.com/akave-ai/akave-docs/blob/master/content/akave-o3/bucket-management/create-list-delete-buckets.md

Command to delete a bucket using the `aws s3api` tool.

```bash
aws s3api delete-bucket \
  --bucket my-akave-bucket \
  --endpoint-url <YOUR_ENDPOINT_URL>
```

--------------------------------

### Load a dataset from Akave O3

Source: https://github.com/akave-ai/akave-docs/blob/master/content/solutions-and-integrations/huggingface.md

Retrieving a previously saved dataset from Akave O3 storage and loading it as a Hugging Face dataset object.

```python
dataset = hf_s3.load_dataset(path="imdb")
print(f"Dataset has {len(dataset)} examples")
print(dataset[0])
```
Tokens:
Raw