Welcome to the Octopipe quickstart guide. This document will help you set up and run your first pipeline in a few simple steps. Follow these instructions to quickly see Octopipe in action and start processing your data.
Step 1: Initialize Your Project
Begin by initializing a new Octopipe project. This command sets up the basic structure and configuration files needed for your pipeline.
octopipe init --name my_pipeline --description "Pipeline for Sales Data"
Tip: The —name flag defines your pipeline’s name, and —description provides context about its purpose.Step 2: Authenticate with OctopipeBefore interacting with the platform, you need to authenticate. Use your API key to log in:
octopipe login --api-key YOUR_API_KEY_HERE
• Note: Ensure your API key is active. Check the authentication section in the documentation if you encounter any issues.Step 3: Add a Data SourceConfigure your data source by adding a connector. For example, to add a sales API as a data source, run:
• Explanation:• —name assigns a unique name to your data source.• —type specifies the kind of source (e.g., api, database, or file).• Additional options such as url and token provide connection details.Step 4: Add a Data DestinationNow, set up where your data will be loaded. For instance, if you’re using PostgreSQL as your destination, run:
• Detail: This command configures the database connection by specifying host, port, credentials, and the target database name.Step 5: Define a TransformationCreate a transformation that maps the type safe API schema to the labeled database schema. You can define this mapping using a schema file:
• Clarification: The transformation aligns API fields with database fields, ensuring data consistency during the load process.Step 6: Create the PipelineWith your components in place, create the pipeline that orchestrates these elements:
• Schedule: The cron expression “0 0 * * *” schedules the pipeline to run daily at midnight.Step 7: Start the PipelineLaunch your pipeline to begin processing data:
octopipe start daily_sales
• Observation: A successful start will display confirmation messages and log entries indicating that data processing has begun.Step 8: Monitor the PipelineTo view real-time updates and logs, use the following command:
octopipe logs daily_sales --follow
• Tip: The —follow option streams live logs to your terminal, allowing you to monitor progress and troubleshoot if needed.Final ThoughtsCongratulations! You have now set up and started your first Octopipe pipeline. This quickstart guide covered initialization, authentication, source and destination configuration, transformation setup, pipeline creation, and monitoring.If you need additional assistance, refer to the detailed documentation or connect with the community for support. Enjoy building robust data pipelines with Octopipe!
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Octopipe","colors":{"primary":"#3b82f6","light":"#3b82f6","dark":"#3b82f6"},"logo":{"light":"https://mintcdn.com/octopipe-749651a5/WzCShlq90jV2SQKt/logo/light.png?fit=max\u0026auto=format\u0026n=WzCShlq90jV2SQKt\u0026q=85\u0026s=0d9665e5818487891062304def9e833b","dark":"https://mintcdn.com/octopipe-749651a5/WzCShlq90jV2SQKt/logo/dark.png?fit=max\u0026auto=format\u0026n=WzCShlq90jV2SQKt\u0026q=85\u0026s=f0575944acca2723d25360ca4bb22e99"},"favicon":"/favicon.ico","navbar":{"links":[{"label":"Support","href":"mailto:james@octopipe.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.octopipe.com"}},"footer":{"socials":{"x":"https://x.com/octopipeai","github":"https://github.com/octopipeai","linkedin":"https://linkedin.com/company/octopipe"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"octopipe-749651a5","hasAudioNarration":false,"actualSubdomain":"octopipe-749651a5","customDomains":["docs.octopipe.com"],"gitSource":{"type":"github","owner":"octopipeai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92881702a829ff5aa4656:success","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Reference","count":11},{"language":"default","tag":"CLI","count":10},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Concepts","count":4},{"language":"default","tag":"Tutorials","count":4},{"language":"default","tag":"Contribute","count":3},{"language":"default","tag":"Getting Started","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"getting-started/quickstart","slug":"/getting-started/quickstart","pageMetadata":{"title":null,"description":null,"href":"/getting-started/quickstart"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`quickstart-with-octopipe`,children:`Quickstart with Octopipe`}),`\n`,_jsx(_components.p,{children:`Welcome to the Octopipe quickstart guide. This document will help you set up and run your first pipeline in a few simple steps. Follow these instructions to quickly see Octopipe in action and start processing your data.`}),`\n`,_jsx(Heading,{level:`2`,id:`step-1-initialize-your-project`,children:`Step 1: Initialize Your Project`}),`\n`,_jsx(_components.p,{children:`Begin by initializing a new Octopipe project. This command sets up the basic structure and configuration files needed for your pipeline.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`octopipe`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` init`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --name`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` my_pipeline`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --description`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Pipeline for Sales Data\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Tip:`}),` The —name flag defines your pipeline’s name, and —description provides context about its purpose.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 2: Authenticate with Octopipe`})}),`\n`,_jsx(_components.p,{children:`Before interacting with the platform, you need to authenticate. Use your API key to log in:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe login --api-key YOUR_API_KEY_HERE`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Note:`}),` Ensure your API key is active. Check the authentication section in the documentation if you encounter any issues.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 3: Add a Data Source`})}),`\n`,_jsx(_components.p,{children:`Configure your data source by adding a connector. For example, to add a sales API as a data source, run:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe source add --name sales_api --type api --option url=https://api.sales.com/data --option token=YOUR_TOKEN`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Explanation:`})]}),`\n`,_jsx(_components.p,{children:`•\t—name assigns a unique name to your data source.`}),`\n`,_jsx(_components.p,{children:`•\t—type specifies the kind of source (e.g., api, database, or file).`}),`\n`,_jsx(_components.p,{children:`•\tAdditional options such as url and token provide connection details.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 4: Add a Data Destination`})}),`\n`,_jsx(_components.p,{children:`Now, set up where your data will be loaded. For instance, if you’re using PostgreSQL as your destination, run:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe destination add --name sales_db --type postgres --option host=localhost --option port=5432 --option user=dbuser --option password=secret --option database=sales`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Detail:`}),` This command configures the database connection by specifying host, port, credentials, and the target database name.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 5: Define a Transformation`})}),`\n`,_jsx(_components.p,{children:`Create a transformation that maps the type safe API schema to the labeled database schema. You can define this mapping using a schema file:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe transform add --name sales_transform --source sales_api --destination sales_db --schema-file ./schemas/sales_schema.json`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Clarification:`}),` The transformation aligns API fields with database fields, ensuring data consistency during the load process.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 6: Create the Pipeline`})}),`\n`,_jsx(_components.p,{children:`With your components in place, create the pipeline that orchestrates these elements:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe pipeline create --name daily_sales --source sales_api --destination sales_db --transform sales_transform --schedule \"0 0 * * *\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Schedule:`}),` The cron expression “0 0 * * *” schedules the pipeline to run daily at midnight.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 7: Start the Pipeline`})}),`\n`,_jsx(_components.p,{children:`Launch your pipeline to begin processing data:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe start daily_sales`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Observation:`}),` A successful start will display confirmation messages and log entries indicating that data processing has begun.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Step 8: Monitor the Pipeline`})}),`\n`,_jsx(_components.p,{children:`To view real-time updates and logs, use the following command:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`octopipe logs daily_sales --follow`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`•\t`,_jsx(_components.strong,{children:`Tip:`}),` The —follow option streams live logs to your terminal, allowing you to monitor progress and troubleshoot if needed.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Final Thoughts`})}),`\n`,_jsx(_components.p,{children:`Congratulations! You have now set up and started your first Octopipe pipeline. This quickstart guide covered initialization, authentication, source and destination configuration, transformation setup, pipeline creation, and monitoring.`}),`\n`,_jsx(_components.p,{children:`If you need additional assistance, refer to the detailed documentation or connect with the community for support. Enjoy building robust data pipelines with Octopipe!`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":null,"description":null,"href":"/getting-started/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Quickstart with Octopipe","slug":"quickstart-with-octopipe","depth":1,"children":[]},{"title":"Step 1: Initialize Your Project","slug":"step-1-initialize-your-project","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"octopipe-749651a5","siteName":"Octopipe","title":"Quickstart - Octopipe","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T08:42:27.087Z","originalFileLocation":"getting-started/quickstart.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Octopipe\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Octopipe\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Octopipe\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.octopipe.com/getting-started/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://octopipe-749651a5.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Quickstart\u0026amp;theme=414b5c67a9ed3ac55b78de21\u0026amp;signature=d49979631f46d4b624be9078a0bdda1d3d19f85caaa983f0d8c7c770304ea617\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Quickstart - Octopipe\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://octopipe-749651a5.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Quickstart\u0026amp;theme=414b5c67a9ed3ac55b78de21\u0026amp;signature=d49979631f46d4b624be9078a0bdda1d3d19f85caaa983f0d8c7c770304ea617\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/octopipe-749651a5/mZbiJLeT-hp4oGVQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Octopipe\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.octopipe.com/getting-started/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.octopipe.com/#organization\",\"name\":\"Octopipe\",\"url\":\"https://docs.octopipe.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/octopipe-749651a5/WzCShlq90jV2SQKt/logo/light.png?fit=max\u0026auto=format\u0026n=WzCShlq90jV2SQKt\u0026q=85\u0026s=0d9665e5818487891062304def9e833b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.octopipe.com#website\",\"name\":\"Octopipe\",\"url\":\"https://docs.octopipe.com\",\"publisher\":{\"@id\":\"https://docs.octopipe.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.octopipe.com/getting-started/quickstart#webpage\",\"url\":\"https://docs.octopipe.com/getting-started/quickstart\",\"name\":\"Quickstart\",\"dateModified\":\"2026-01-07T08:42:27.087Z\",\"isPartOf\":{\"@id\":\"https://docs.octopipe.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.octopipe.com/getting-started/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"url\":\"https://docs.octopipe.com/getting-started/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.octopipe.com/getting-started/quickstart#webpage\"},\"dateModified\":\"2026-01-07T08:42:27.087Z\",\"publisher\":{\"@id\":\"https://docs.octopipe.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.octopipe.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Octopipe\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Octopipe\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/getting-started/quickstart.md","siteName":"Octopipe","nav":{"global":null,"anchors":[{"anchor":"Getting Started","icon":"rocket","pages":[{"title":null,"description":null,"href":"/getting-started/installation"},{"title":null,"href":"/getting-started/quickstart"},{"title":null,"description":null,"href":"/getting-started/overview"}]},{"anchor":"Concepts","icon":"lightbulb","pages":[{"title":null,"href":"/concepts/architecture"},{"title":null,"href":"/concepts/transform-layer"},{"title":null,"href":"/concepts/type-safe-api"},{"title":null,"href":"/concepts/pipeline-flow"}]},{"anchor":"Guides","icon":"book","pages":[{"title":null,"href":"/guides/cli-usage"},{"title":null,"href":"/guides/pipeline-management"},{"title":null,"href":"/guides/configuration"},{"title":null,"href":"/guides/self-hosting"},{"title":null,"href":"/guides/advanced-topics"}]},{"anchor":"Reference","icon":"code","pages":[{"title":null,"href":"/reference/glossary"},{"group":"CLI","pages":[{"title":null,"href":"/reference/cli/init"},{"title":null,"href":"/reference/cli/login"},{"title":null,"href":"/reference/cli/source"},{"title":null,"href":"/reference/cli/destination"},{"title":null,"href":"/reference/cli/transform"},{"title":null,"href":"/reference/cli/pipeline"},{"title":null,"href":"/reference/cli/start"},{"title":null,"href":"/reference/cli/stop"},{"title":null,"href":"/reference/cli/logs"},{"title":null,"href":"/reference/cli/config"}]}]},{"anchor":"Tutorials","icon":"graduation-cap","pages":[{"title":null,"href":"/tutorials/creating-a-pipeline"},{"title":null,"href":"/tutorials/using-the-cli"},{"title":null,"href":"/tutorials/deploying-to-cloud"},{"title":null,"href":"/tutorials/troubleshooting"}]},{"anchor":"Contribute","icon":"hand-wave","pages":[{"title":null,"href":"/contribute/contributing"},{"title":null,"href":"/contribute/style-guide"},{"title":null,"href":"/contribute/code-of-conduct"}]}]},"basePath":"","title":"Quickstart - Octopipe","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}