@begin/api

Node client for api.begin.com

Obtain an token by creating a client at https://api.begin.com.

Install

npm i @begin/api

Usage

ESM

import { App } from '@begin/api'

CJS

const { App } = require('@begin/api')

App static methods

// list apps
let { apps } = await App.list()

// find an app by id
let app = await App.find({ access_token, appID })

// list regions available to create a new app with
let app = await App.regions({ access_token, zip })

// create a new app
let app = await App.create({ access_token, zip })

// create a new app using @begin/chunker
let app = await App.create({ access_token, chunk, zip })

App instance methods

// read app logs
let logs = await App.logs()

// read build logs
let logs = await App.builds()

// deploy a new version of the app
await App.deploy({ zip })

// deploy a new version of the app using @begin/chunker
await App.deploy({ chunk, zip })

// destroy an app
await App.destroy()

Work with environment variables

// get the app env
let { env } = await App.env.get()

// write an env var
await App.env.set({ key: "HENLO", value: "world" })

// remove an env var
await App.env.destroy({ key: "HENLO" })

Work with static assets

// get the app env
let { files } = await App.static.get()

// write a file
let body = Buffer.from('console.log("hi")').toString('base64')
await App.static.set({ name: '/file.js', body  })

// remove the file
await App.static.destroy({ name: '/file.js' })

Contributing

Create .env with the following values:

BEGIN_CLIENT_ID=xxx
ACCESS_TOKEN=xxx
# __BEGIN_TEST_URL__=localhost:3333