npmpackage.info

@sap/cf-tools

This package provides a set of APIs for easy application development with Cloud Foundry. You can use these APIs to manage apps, service instances, orgs, spaces, and users in your environment.

3.2.2

Apache-2.0

TypeScript

65.29 kB

Installations

npm install @sap/cf-tools

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

22.8.0

NPM Version

10.8.2 Score

83.3

Supply Chain

86.1

Quality

76.6

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

8

Total

172

Closed

63

Merged

101

Issues

Open

0

Total

4

Closed

4

Releases

v3.2.2

Published on 16 Sept 2024

v3.2.0

Published on 15 Feb 2023

v3.0.1

Published on 25 Apr 2022

v3.0.0

Published on 17 Apr 2022

v2.2.0

Published on 09 Feb 2022

v2.1.1

Published on 06 Dec 2021

View all 29 releases

Contributors

602

Unable to fetch Contributors

View all 602 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (98.5%)

JavaScript (1.47%)

Shell (0.04%)

Developer

sap

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

8 Stars

144 Commits

8 Forks

8 Watching

11 Branches

602 Contributors

Bundle Size

238.37 kB

Minified

65.29 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

3.2.2

Package Id

@sap/cf-tools@3.2.2

Unpacked Size

72.47 kB

Size

17.63 kB

File Count

NPM Version

10.8.2

Node Version

22.8.0

Publised On

16 Sept 2024

Total Downloads

Cumulative downloads

Total Downloads

0

Last day

Compared to previous day

Last week

Compared to previous week

Last month

Compared to previous month

Last year

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

GitHub package.json version

Overview

This package provides a set of APIs to help you develop applications in Cloud Foundry. You can use these APIs to manage apps, service instances, orgs, spaces, and users in your environment. Mostly, this is a wrapper of the CF command line client, which runs a particular command and parses the output to the suitable JSON file. If an error or failure occurs, the runtime exception throws with relevant problem information.

API Reference Guide

API guide

Prerequisite

from version v1.0.0 and above:

Make sure you have installed the CF CLI v7 tool in your environment.

below version v1.0.0:

Make sure you have installed the CF CLI v6 tool in your environment.

Examples of usage

Example 1

try {
	const result = await cfLogin("https://api.cf.....com", "user", "password");
	if (result === "OK") {
		// successful
	}
} catch (e) {
	// display or/and log error
}

Example 2

try {
	const spaces = await cfGetAvailableSpaces("myOrg");
	for (const space of spaces) {
		console.log("Space label is " + space.label + " guid is " + space.guid);
	}
} catch (e) {
	// display or/and log error
}

Contributing

Contributing information can be found in the CONTRIBUTING.md file.

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commitlint.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/commitlint.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/commitlint.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/commitlint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/SAP/cloud-foundry-tools-api/release.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:33
Warn: npmCommand not pinned by hash: .github/workflows/release.yml:19
Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

SAST

Determines if the project uses static code analysis.

Score

4

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@sap/cf-tools

Installations

Developer Guide

Yes

CommonJS

22.8.0

10.8.2

Score

Pull Requests

8

172

63

101

Issues

0

4

4

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

238.37 kB

65.29 kB

Maintainers

Package Meta Information

Total Downloads

0

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Overview

API Reference Guide

Prerequisite

Examples of usage

Contributing

10

10

10

10

5

4

0

0

0

0

0

0

0

4

/10