Gathering detailed insights and metrics for contentful-cli
Gathering detailed insights and metrics for contentful-cli
Installations
npm install contentful-cliScore
61.3
Supply Chain
85.2
Quality
93.2
Maintenance
100
Vulnerability
91.6
License
Developer
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>=18
Typescript Support
No
Node Version
18.18.0
NPM Version
10.9.0
Statistics
329 Stars
2,011 Commits
61 Forks
68 Watching
25 Branches
266 Contributors
Updated on 26 Nov 2024
Languages
JavaScript (60.66%)
TypeScript (39.24%)
Shell (0.09%)
HTML (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
8,485,450
Last day
7.7%
11,592
Compared to previous day
Last week
-6%
57,087
Compared to previous week
Last month
5.1%
293,497
Compared to previous month
Last year
35.9%
2,292,319
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
42
@contentful/app-action-utilsast-typesbluebirdboxencamelcasechalkcli-highlightcli-table3command-existscontentful-batch-libscontentful-collectioncontentful-exportcontentful-importcontentful-managementcontentful-migrationemojicexecafigletfind-uphttps-proxy-agentinquirerinquirer-autocomplete-promptinquirer-select-directorylistrlodashmarkedmkdirpopenp-queuepapaparsepatch-packagepathprettierrecastrxjsshell-escapetarto-asttree-killtypescriptwrap-ansiyargs
Dev Dependencies
39
@babel/core@babel/preset-env@babel/preset-typescript@contentful/integration-test-utils@types/inquirer@types/inquirer-autocomplete-prompt@types/jest@types/listr@types/lodash@types/node@types/papaparse@types/yargs@typescript-eslint/eslint-plugin@typescript-eslint/parserapp-root-pathaxiosbabel-jestconcurrentlycross-envcz-conventional-changelogeslinteslint-config-prettiereslint-plugin-jesteslint-plugin-prettierhttp-proxyhuskyjestjest-junitjsziplint-stagednixtnycpkgrimrafsemantic-releasestream-buffersstrip-ansitalkbacktypescript
Versions
Contentful CLI
Contentful's command line interface tool. Use Contentful features straight from your CLI.
Contentful provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
:rocket: Features
- Get started with Contentful with the
initcommand. - Manage spaces - list, create, delete,...
- Export your space to a JSON file.
- Import your space from a JSON file.
- Execute migration scripts written in the Contentful Migration DSL
- Generate migration scripts for the Contentful Migration DSL from existing spaces.
- Seed your space with example data.
- Manage installation of extensions in a space.
- Securely login and logout with our OAuth service.
- Find all available commands in the docs section.
:cloud: Installation
Make sure you have Node LTS installed
1npm install -g contentful-cli 2# Or 3yarn global add contentful-cli
Please note that for the non standalone versions you need Node LTS to use the CLI.
:hand: Usage
Use the --help parameter to display the help section for CLI tool or combined with a specific command to get the help section for that command.
1contentful --help 2# Or 3contentful space --help
:books: Documentation
More detailed documentation for every command can be found in the docs section.
Using the CLI tool with a proxy
You can save the proxy configuration in your .contentfulrc.json via:
1contentful config add --proxy user:auth@host:port
We also respect the http(s)_proxy environment variables:
1https_proxy=user:auth@host:port contentful
When multiple proxy configurations exists, precedence is taken in this form:
http_proxytakes precedence over.contentfulrc.jsonhttps_proxytakes precedence over.contentfulrc.jsonhttps_proxytakes precedence overhttp_proxy
Configuring the CLI for EU usage
You can override the host configuration in your .contentfulrc.json via:
1contentful config add --host api.eu.contentful.com --host-delivery cdn.eu.contentful.com
Then any subsequent command will use the EU hosts. E.g. contentful login will log you in to your EU Contentful instance.
:rescue_worker_helmet: Troubleshooting
- Unable to connect to Contentful through your Proxy? Try settings
rawProxy: truein your.contentfulrc.jsonvia:
1contentful config add --raw-proxy
:hammer_and_wrench: Development
- Install dependencies
1npm i - To avoid development version colliding with your already installed Contentful CLI, change the command name in
package.json1 "bin": { 2- "contentful": "bin/contentful.js" 3+ "ctfl": "bin/contentful.js" 4 } - Link your local version, and happy hacking :tada:
1npm link
:question: Support
If you have a problem with this tool, please file an issue here on Github.
If you have other problems with Contentful not related to this library, you can contact Customer Support.
:writing_hand: Contributing
See CONTRIBUTING.md
:scroll: License
MIT
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
all changesets reviewed
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.txt:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/contentful/.github/SECURITY.md:1
- Info: Found linked content: github.com/contentful/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/contentful/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/contentful/.github/SECURITY.md:1
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/dependabot-approve-and-request-merge.yml:8
- Warn: no topLevel permission defined: .github/workflows/dependabot-approve-and-request-merge.yml:1
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-22r3-9w55-cj54
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependabot-approve-and-request-merge.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/contentful/contentful-cli/dependabot-approve-and-request-merge.yml/main?enable=pin
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v3.7.0 not signed: https://api.github.com/repos/contentful/contentful-cli/releases/187588312
- Warn: release artifact v3.6.5 not signed: https://api.github.com/repos/contentful/contentful-cli/releases/187447112
- Warn: release artifact v3.6.4 not signed: https://api.github.com/repos/contentful/contentful-cli/releases/187423661
- Warn: release artifact v3.6.3 not signed: https://api.github.com/repos/contentful/contentful-cli/releases/187422639
- Warn: release artifact v3.6.2 not signed: https://api.github.com/repos/contentful/contentful-cli/releases/187419504
- Warn: release artifact v3.7.0 does not have provenance: https://api.github.com/repos/contentful/contentful-cli/releases/187588312
- Warn: release artifact v3.6.5 does not have provenance: https://api.github.com/repos/contentful/contentful-cli/releases/187447112
- Warn: release artifact v3.6.4 does not have provenance: https://api.github.com/repos/contentful/contentful-cli/releases/187423661
- Warn: release artifact v3.6.3 does not have provenance: https://api.github.com/repos/contentful/contentful-cli/releases/187422639
- Warn: release artifact v3.6.2 does not have provenance: https://api.github.com/repos/contentful/contentful-cli/releases/187419504
Score
7
/10
Last Scanned on 2024-11-25
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