contentful-management.js

(★ 287)

JavaScript library for Contentful's Management API (node & browser)

File Explorer

Download Latest Version (.zip)

- vault-secrets.yaml
- - bug_report.md
  - config.yml
  - feature_request.md
- - build.yaml
  - check.yaml
  - codeql.yaml
  - main.yaml
  - release.yaml
  - test-demo-projects.yaml
  - test-integration.yaml
- CODEOWNERS
- PULL_REQUEST_TEMPLATE.md
- pre-commit
- contentful-icon.png
- - access-token.ts
  - agent-run.ts
  - agent.ts
  - ai-action-invocation.ts
  - ai-action.ts
  - api-key.ts
  - app-access-token.ts
  - app-action-call.ts
  - app-action.ts
  - app-bundle.ts
  - app-definition.ts
  - app-details.ts
  - app-event-subscription.ts
  - app-installation.ts
  - app-key.ts
  - app-signed-request.ts
  - app-signing-secret.ts
  - app-upload.ts
  - asset-key.ts
  - asset.ts
  - automation-definition.ts
  - automation-execution.ts
  - available-license.ts
  - bulk-action.ts
  - comment.ts
  - component-type.ts
  - component.ts
  - concept-scheme.ts
  - concept.ts
  - content-semantics-index.ts
  - content-type-fields.ts
  - content-type.ts
  - data-assembly.ts
  - design-token.ts
  - editor-interface.ts
  - eligible-license.ts
  - entry.ts
  - environment-alias.ts
  - environment-template-installation.ts
  - environment-template.ts
  - environment.ts
  - experience-fragment.ts
  - experience-template.ts
  - experience.ts
  - extension.ts
  - field-type.ts
  - fragment.ts
  - function-log.ts
  - function.ts
  - locale.ts
  - oauth-application.ts
  - organization-invitation.ts
  - organization-membership.ts
  - organization.ts
  - personal-access-token.ts
  - preview-api-key.ts
  - release-action.ts
  - release.ts
  - resource-provider.ts
  - resource-type.ts
  - resource.ts
  - role.ts
  - scheduled-action.ts
  - semantic-duplicates.ts
  - semantic-recommendations.ts
  - semantic-reference-suggestions.ts
  - semantic-search.ts
  - semantic-settings.ts
  - snapshot.ts
  - space-add-on.ts
  - space-member.ts
  - space-membership.ts
  - space.ts
  - tag.ts
  - task.ts
  - team-membership.ts
  - team-space-membership.ts
  - team.ts
  - template.ts
  - ui-config.ts
  - upload-credential.ts
  - upload.ts
  - usage.ts
  - user-ui-config.ts
  - user.ts
  - utils.ts
  - webhook.ts
  - widget-parameters.ts
  - workflow-definition.ts
  - workflow.ts
  - workflows-changelog-entry.ts
- - action.ts
  - content-type.ts
  - release-action.ts
  - utils.ts
- - as-iterator.ts
  - checks.ts
  - pagination-helper.ts
  - plain-client-types.ts
  - plain-client.ts
- common-types.ts
- common-utils.ts
- create-adapter.ts
- create-app-definition-api.ts
- create-contentful-api.ts
- create-entry-api.ts
- create-environment-api.ts
- create-environment-template-api.ts
- create-organization-api.ts
- create-space-api.ts
- create-ui-config-api.ts
- create-user-ui-config-api.ts
- enhance-with-methods.ts
- export-types.ts
- index.ts
- upload-http-client.ts
- - agent-integration.test.ts
  - ai-action-integration.test.ts
  - ai-action-invocation-integration.test.ts
  - api-key-integration.test.ts
  - app-access-token-integration.test.ts
  - app-action-call-structured-integration.test.ts
  - app-action-integration.test.ts
  - app-bundle-integration.test.ts
  - app-definition-integration.test.ts
  - app-details-integration.test.ts
  - app-event-subscription-integration.test.ts
  - app-key-integration.test.ts
  - app-signed-request-integration.test.ts
  - app-signing-secret-integration.test.ts
  - app-upload-integration.test.ts
  - asset-integration.test.ts
  - asset-key-integration.test.ts
  - bulk-action-integration.test.ts
  - comment-integration.test.ts
  - component-integration.test.ts
  - component-type-integration.test.ts
  - content-type-integration.test.ts
  - data-assembly-integration.test.ts
  - design-token-integration.test.ts
  - entry-integration.test.ts
  - entry-references-integration.test.ts
  - environment-alias-integration.test.ts
  - environment-integration.test.ts
  - environment-template-integration.test.ts
  - experience-fragment-integration.test.ts
  - experience-integration.test.ts
  - experience-template-integration.test.ts
  - fragment-integration.test.ts
  - locale-integration.test.ts
  - org-team-space-membership-integration.test.ts
  - organization-integration.test.ts
  - organization-invitation.test.ts
  - organization-membership-integration.test.ts
  - organization-space-membership-integration.test.ts
  - plain-client.test.ts
  - preview-api-key-integration.test.ts
  - release-action-integration.test.ts
  - release-integration.test.ts
  - releasev2-integration.test.ts
  - resource-integration.test.ts
  - resource-provider-integration.test.ts
  - resource-type-integration.test.ts
  - role-integration.test.ts
  - scheduled-action-integration.test.ts
  - space-add-on-integration.test.ts
  - space-integration.test.ts
  - space-member-integration.test.ts
  - space-membership-integration.test.ts
  - space-team-integration.test.ts
  - space-user-integration.test.ts
  - tag-integration.test.ts
  - task-integration.test.ts
  - taxonomy-integration.test.ts
  - team-integration.test.ts
  - team-membership-integration.test.ts
  - team-space-membership-integration.test.ts
  - template-integration.test.ts
  - ui-extension-integration.test.ts
  - upload-credential.test.ts
  - usage-integration.test.ts
  - user-integration.test.ts
  - webhook-integration.test.ts
  - workflow-integration.test.ts
- - contentful-management.test.ts
  - create-adapter.test.ts
  - create-app-definition-api.test.ts
  - create-contentful-api.test.ts
  - create-entry-api.test.ts
  - create-environment-api.test.ts
  - create-environment-template-api.test.ts
  - create-organization-api.test.ts
  - create-space-api.test.ts
  - create-ui-config-api.test.ts
  - create-user-ui-config-api.test.ts
- defaults.ts
- helpers.ts
- utils.ts
.gitignore
.npmrc
.nvmrc
.prettierignore
.prettierrc
catalog-info.yaml
CHANGELOG.md
CONTRIBUTING.md
eslint.config.mjs
LICENSE
MIGRATION.md
package-lock.json
package.json
README.md
renovate.json
rollup.config.mjs
SETUP.md
SUPPORT.md
tsconfig.json
typedoc.config.mjs
vitest.config.ts
vitest.setup.browser.ts
vitest.setup.ts
vitest.setup.unit.ts
vitest.workspace.js

# Installation Guide

1. Get the code

git clone https://github.com/contentful/contentful-management.js

Downloads the entire project code from GitHub to your computer.

cd contentful-management.js

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install contentful-management

Downloads and installs the libraries listed in package.json.

yarn add contentful-management

Type this command into your terminal and run it.

<script src="https://cdn.jsdelivr.net/npm/contentful-management@12"></script>

Type this command into your terminal and run it.

npm install contentful-management@canary

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.