@last-rev/contentful-sync-to-fs
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.8 • Public • Published

    Overview

    This library syncs content from contentful to the local filesystem. Can be called directly from code as a library, or as a CLI.

    Usage

    CLI

    npm install -g @last-rev/cli
    
    last-rev cms-sync -d graphql/content

    See Docs for details on the parameters.

    Library

    import sync from '@last-rev/contentful-sync-to-fs'
    
    async function () {
      await sync({
        rootDir: './graphql/content', // Root directory to sync content to
        accessToken: process.env.CONTENTFUL_ACCESSTOKEN, // Contentful access token
        space: process.env.CONTENTFUL_SPACE_ID, // Contentful space ID
        environment: process.env.CONTENTFUL_ENV || 'master', // Contentful environment
        host = process.env.CONTENTFUL_HOST || 'cdn.contentful.com' // Contentful host
      });
    };

    Output

    The library outputs all content to the passed in rootDir location in the following structure:

    • Entries: {space_id}/{environment}/{preview_or_production}/entries/{entry_id}.json
    • Assets: {space_id}/{environment}/{preview_or_production}/assets/{asset_id}.json
    • Content Types: {space_id}/{environment}/{preview_or_production}/content_types/{contentTypeId}.json
    • Entry IDs by Content type lookup: {space_id}/{environment}/{preview_or_production}/entry_ids_by_content_type/{entryId} - Note, this file has no content. The titles in the directory will simply be read to get the IDs

    Keywords

    none

    Install

    npm i @last-rev/contentful-sync-to-fs

    DownloadsWeekly Downloads

    400

    Version

    0.3.8

    License

    ISC

    Unpacked Size

    25.3 kB

    Total Files

    12

    Last publish

    Collaborators

    • maxtechera.lastrev
    • tharris
    • justinlastrev
    • jaimelastrev
    • bradtaylorsf