ShardCloud SDK

Official SDK for the ShardCloud API - platform for hosting applications and databases.

Installation

npm install shardcloud

How to Use

1. Import and Setup

import ShardCloudClient from 'shardcloud';
// or import { ShardCloudClient } from 'shardcloud';

const client = new ShardCloudClient('your-api-key');
const apps = client.apps();
const databases = client.databases();

2. Applications Examples

List all applications

const allApps = await apps.getAll();
console.log(allApps);

Get a specific application

const app = await apps.get('app-id');
console.log(app);

Start, stop, or restart

await apps.start('app-id');
await apps.stop('app-id');
await apps.restart('app-id');

Check status

const status = await apps.status('app-id');
console.log(status);

Upload application (ZIP file)

const result = await apps.upload('./my-app.zip');
console.log('App created with ID:', result.id);

Create file

await apps.file.create('app-id', 'test.txt', 'Hello World');

Read file

const content = await apps.file.content('app-id', 'test.txt');
console.log(content);

List files

const files = await apps.file.getAll('app-id');
console.log(files);

Update resources

await apps.resources('app-id', {
  ram: 512,
  vcpu: 1,
  name: 'My App'
});

Configure domain

await apps.domain.update('app-id', 'myapp.example.com');

3. Databases Examples

Create database

import { DatabaseType } from 'shardcloud';

const result = await databases.create({
  type: DatabaseType.Postgres,
  name: 'my-database',
  password: 'secure-password',
  ram: 256
});

console.log('Database created with ID:', result.id);

List all databases

const allDatabases = await databases.getAll();
console.log(allDatabases);

Get a specific database

const db = await databases.get('database-id');
console.log(db);

Get connection URL

const connection = await databases.connectionUrl('database-id');
console.log('URL:', connection.connection_url);

Update resources

await databases.update.resources('database-id', {
  ram: 512,
  vcpu: 2
});

Update password

await databases.update.password('database-id', 'new-password');

Check status

const status = await databases.status('database-id');
console.log(status);

Database Types

DatabaseType.Postgres  // PostgreSQL
DatabaseType.MySQL     // MySQL
DatabaseType.MongoDB   // MongoDB
DatabaseType.Redis     // Redis

Complete Example

import ShardCloudClient from 'shardcloud';

const client = new ShardCloudClient('your-api-key');
const apps = client.apps();

// List applications
const allApps = await apps.getAll();
console.log('Applications:', allApps);

// Start an application
await apps.start('app-id');

// Check status
const status = await apps.status('app-id');
console.log('Status:', status);

Links

• API Documentation
• Discord
• Website