Platform.sh API client library
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Build Status

Platform.sh API client

This is a isomorphic Javascript library for accessing the Platform.sh API.

Our API is not stable yet. We recommend you use the Platform.sh CLI for most purposes.

Install

Run npm install platformsh-client

Usage

import Client from 'platformsh-client';

const client = new Client({
  api_token: /* api token if you use it with NodeJS*/,
  redirect_uri: /* custom redirection uri if you use it in the browser (current uri by default)*/
});

client.getProjects().then(projects => {
  const project = projects[0];

  const giturl = project.getGitUrl();
});

Development mode

Run npm run dev

Build

Run npm run build

Test

Run npm test