# cf-client > A Cloud Foundry Client for Node.js Latest version **0.13.26** (published 2016-10-07) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install cf-client pnpm add cf-client yarn add cf-client bun add cf-client ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.13.26 | | Published | 2016-10-07 | | First published | 2016-03-28 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=4.2.3 | | Dependencies | 5 | | Known vulnerabilities | 0 (+16 in 3 direct dependencies) | | Install scripts | no | | GitHub stars | 10 | | Author | Juan Antonio Breña Moral | | Maintainers | cphrmky, jsloyer, theophoric, triceam | | Keywords | cloud foundry, cloudfoundry, cloud-foundry, vcap, pivotal, pivotalcf, ibm, bluemix, cloud, api, REST, cf, cf client, paas | ## Links - npm: https://www.npmjs.com/package/cf-client - Repository: https://github.com/IBM-Bluemix/cf-nodejs-client - Issues: https://github.com/IBM-Bluemix/cf-nodejs-client/issues - npm.io page: https://npm.io/package/cf-client ## Dependencies (5) - [ws](https://npm.io/package/ws.md) 1.1.1 - [request](https://npm.io/package/request.md) 2.67.0 - [restler](https://npm.io/package/restler.md) 3.4.0 - [bluebird](https://npm.io/package/bluebird.md) 3.0.6 - [protobufjs](https://npm.io/package/protobufjs.md) 5.0.1 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 0.13.26 (latest) — 2016-10-07 - 0.13.25 — 2016-08-22 - 0.13.24 — 2016-08-22 - 0.13.23 — 2016-08-22 - 0.13.22 — 2016-08-21 - 0.13.21 — 2016-08-01 - 0.13.20 — 2016-06-21 - 0.13.19 — 2016-06-13 - 0.13.18 — 2016-06-01 - 0.13.17 — 2016-06-01 - 0.13.16 — 2016-05-31 - 0.13.15 — 2016-05-16 - 0.13.14 — 2016-05-16 - 0.13.13 — 2016-05-16 - 0.13.12 — 2016-05-13 - … 12 more at https://npm.io/package/cf-client/versions ## README # cf-client [![Build Status](https://travis-ci.org/IBM-Bluemix/cf-nodejs-client.svg)](https://travis-ci.org/IBM-Bluemix/cf-nodejs-client) [![Build status](https://ci.appveyor.com/api/projects/status/adxrubgykqys7pp9?svg=true)](https://ci.appveyor.com/project/jsloyer/cf-nodejs-client) [![Dependency Status](https://david-dm.org/IBM-Bluemix/cf-nodejs-client.svg)](https://david-dm.org/IBM-Bluemix/cf-nodejs-client) [![devDependency Status](https://david-dm.org/IBM-Bluemix/cf-nodejs-client/dev-status.svg)](https://david-dm.org/IBM-Bluemix/cf-nodejs-client#info=devDependencies) [![Changelog](https://img.shields.io/badge/see-CHANGELOG-red.svg?style=flat-square)](https://github.com/IBM-Bluemix/cf-nodejs-client/blob/master/CHANGELOG.md) [![API Doc](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master.svg)](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master) [![NPM](https://nodei.co/npm/cf-client.png?stars=true)](https://nodei.co/npm/cf-client/) # Table of Contents - [Overview](#overview) - [Focus](#focus) - [Getting Started](#getting-started) - [JSDoc](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master) - [Changelog](https://github.com/IBM-Bluemix/cf-nodejs-client/blob/master/CHANGELOG.md) - [Testing](#testing) - [Issues](#issues) - [References](#references) # Overview This project provides a simple client library to interact with the [Cloud Foundry Architecture](https://docs.pivotal.io/pivotalcf/concepts/architecture/): ![ScreenShot](https://raw.githubusercontent.com/IBM-Bluemix/cf-nodejs-client/master/docs/cf_architecture_block.png) Using this library, you could interact with the following platforms: [PWS](https://console.run.pivotal.io) , [Bluemix](https://console.ng.bluemix.net/) or a [Local Cloud Foundry instance](https://github.com/yudai/cf_nise_installer): | **[Cloud Controller](http://apidocs.cloudfoundry.org/)** | **[UAA](https://github.com/cloudfoundry/uaa)** | **Logging & Metrics** | |------------------------ |----------------------- |------------------------ | | [Apps](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Apps) | [Users](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-UsersUAA) | [Logs](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Logs) | | [Buildpacks](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-BuildPacks) | | | | [Domains](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Domains) | | | | [Jobs](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Jobs) | | | | [Organizations](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Organizations) | | | | [Organizations Quotas](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-OrganizationsQuota) | | | | [Routes](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Routes) | | | | [Services](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Services) | | | | [Service Bindings](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-ServiceBindings) | | | | [Service Instances](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-ServiceInstances) | | | | [Service Plans](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-ServicePlans) | | | | [Spaces](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Spaces) | | | | [Spaces Quotas](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-SpacesQuota) | | | | [Stacks](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Stacks) | | | | [User provided Services](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-UserProvidedServices) | | | | [Users](https://doclets.io/IBM-Bluemix/cf-nodejs-client/master#dl-Users) | | | # Focus The development doesn't cover the whole CloudController API. Main areas of development are: **App life cycle:** * Create an App * Upload source code in .zip or .war (Support for Static, Python, PHP, Node.js & JEE) * Create an User Provided Services * Associate Apps with an User Provided Services * Start | Stop an App * Restage Apps * Scale Apps * Simple Logs management * Remove Apps * Remove User Provided Services **PaaS Management:** * Organization quota * Organization * Space * Services, Service Instances, Service Plans, User provided Services & Service Binding * UAA Users * Users # Getting Started If you need to interact with a Cloud Foundry platform try this [online tool](https://tonicdev.com/npm/cf-client) and use this example: ``` Javascript "use-strict"; const endpoint = "https://api.ng.bluemix.net"; const username = "BLUEMIX_USERNAME"; const password = "BLUEMIX_PASSWORD"; const CloudController = new (require("cf-client")).CloudController(endpoint); const UsersUAA = new (require("cf-client")).UsersUAA; const Apps = new (require("cf-client")).Apps(endpoint); CloudController.getInfo().then( (result) => { UsersUAA.setEndPoint(result.authorization_endpoint); return UsersUAA.login(username, password); }).then( (result) => { Apps.setToken(result); return Apps.getApps(); }).then( (result) => { console.log(result); }).catch( (reason) => { console.error("Error: " + reason); }); ``` Explore the library and if you like the features, use it on your App: ``` Javascript npm install cf-client --save ``` # Testing This project has a test suite to ensure the readability of this project. Take a look the [Tests cases](https://github.com/jabrena/cf-nodejs-client/tree/master/test/) developed with [Mocha](https://mochajs.org/) & [Chai](http://chaijs.com/api/bdd/) to understand some stuff about [Cloud Foundry](https://www.cloudfoundry.org/) and the usage of this client. Besides, the project has invested some amount of time in testing phase to be the code with a nice coverage level. The development has been tested with: | [Local Instance](https://github.com/yudai/cf_nise_installer) | [PWS](https://console.run.pivotal.io) | [Bluemix](https://console.ng.bluemix.net/) | | -------------- |:-------------:| -------:| | 2.25.0 | 2.47.0 | 2.40.0 | **Last test:** 2016/01/26 **Testing against Bluemix:** ``` shell export BLUEMIX_CF_API_URL=https://api.ng.bluemix.net && export BLUEMIX_username=$USERNAME && export BLUEMIX_password=$PASSWORD && npm run test:bluemix ``` **Test suite:** ``` shell npm test ``` **Code coverage:** ``` shell istanbul cover node_modules/mocha/bin/_mocha -- -R spec ``` # Issues If you have any question or doubt, please [create an issue](https://github.com/IBM-Bluemix/cf-nodejs-client/issues). # License Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). # References * API Docs: http://apidocs.cloudfoundry.org/ * Developer list: https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/ * PWS Console: https://console.run.pivotal.io * Bluemix Console: https://console.ng.bluemix.net/ * PWS Forum: https://support.run.pivotal.io/forums * Bluemix Forum: https://developer.ibm.com/answers/ * CF for Beginners: From Zero to Hero http://slides.cf-hero.cloudcredo.io/ --- _Source: https://npm.io/package/cf-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._