akeneo-cc-setup

Category: Ops & Delivery | Uploader: akeneo | Downloads: 0 | Version: v1.0（Latest）

Guides a user through building and deploying an Akeneo Custom Component from scratch. Invoked manually via /akeneo-cc-setup.

Changelog: Source: GitHub https://github.com/akeneo/extension-sdk

Directory Structure

Current level: skills/akeneo-cc-setup/

📄 path-existing.md 5.2 KB
📄 path-handsoff.md 5.5 KB
📄 path-handson.md 9.6 KB
📄 reference.md 26.6 KB
📄 SKILL.md 4.0 KB
📄 upload-api.md 6.7 KB
📄 upload-ui.md 1.5 KB

SKILL.md

---
name: akeneo-cc-setup
description: Guides a user through building and deploying an Akeneo Custom Component from scratch. Invoked manually via /akeneo-cc-setup.
user-invokable: true
context: fork
allowed-tools: Read, Write, Edit, Bash
---

You are guiding a user through building and deploying an Akeneo Custom Component. Follow these steps exactly.

---

## Step 1 — Introduce yourself and ask the starting question

**If `[USER_INTENT]` is set**, open with:

> "I'll help you build that. We'll start by bootstrapping a working Custom Component — once it's live in your PIM, I'll implement [USER_INTENT] directly. First — are you starting from scratch, or do you already have an existing project?"

**If `[USER_INTENT]` is not set**, open with:

> "I'll guide you through building and deploying a Custom Component in Akeneo. First — are you starting from scratch, or do you already have an existing project you want to upload or iterate on?"

---

## Step 2 — Route to the right path

### Existing project

If the user already has a project, read and follow `${CLAUDE_SKILL_DIR}/path-existing.md` in full. That path handles discovery, validation, and upload — no further questions needed here.

### New project

If the user is starting from scratch, ask three questions in one message:

> "Three quick questions to get started:
>
> 1. **Name** — What would you like to call your component?
> 2. **Involvement** — Should I handle everything and just explain what I did, or walk you through each step so you can maintain the code yourself?
> 3. **Upload method** — Once it's built, do you want to upload via the PIM admin UI (no credentials needed) or automatically via the API (requires a PIM Connection or App token)?"

Wait for the user's reply. All three answers may come in one message or across a few — collect them before proceeding. If any answer is missing or unclear, ask only about the missing ones.

Once all three answers are collected, read the following files **simultaneously in a single parallel batch** — do not read them sequentially:

- The path file for Question 2:

| Answer | File |
|---|---|
| Hands-off — agent handles everything | `${CLAUDE_SKILL_DIR}/path-handsoff.md` |
| Hands-on — user wants to own the code | `${CLAUDE_SKILL_DIR}/path-handson.md` |

- The upload sub-flow for Question 3:

| Answer | File |
|---|---|
| UI upload | `${CLAUDE_SKILL_DIR}/upload-ui.md` |
| curl + API | `${CLAUDE_SKILL_DIR}/upload-api.md` |

- `${CLAUDE_SKILL_DIR}/reference.md`

If the answer to Question 2 is ambiguous, default to hands-off and mention you can switch if they want more detail.

With all three files loaded, follow the path file in full. `reference.md` is already in context — the path file will not ask you to read it again.

Carry the component name from Question 1 throughout the entire session. If the user did not have a name, help them pick one before starting the path (snake_case, no spaces, unique in their PIM).

---

## Step 3 — Wrap up

Close the session with:

1. **Summary** — one or two sentences: what was built and where it now appears in the PIM.
2. **Relevant doc links** — pick from the list below based on what came up during the session.
3. **Next steps** — what the user should do next (iterate on the UI, add credentials for external services, set up a CI/CD deploy, etc.).

Doc links to draw from:
- Overview: https://api.akeneo.com/advanced-extensions/overview.html
- SDK in depth: https://api.akeneo.com/advanced-extensions/sdk-in-depth.html
- Development workflow: https://api.akeneo.com/advanced-extensions/development-workflow.html
- API deployment: https://api.akeneo.com/advanced-extensions/api-deployment.html
- UI deployment: https://api.akeneo.com/advanced-extensions/ui-deployment.html
- Credentials: https://api.akeneo.com/advanced-extensions/sdk-credentials.html
- Available positions: https://api.akeneo.com/extensions/positions.html
- FAQ & Troubleshooting: https://api.akeneo.com/advanced-extensions/faq.html
- Extension SDK repo: https://github.com/akeneo/extension-sdk

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

akeneo-cc-setup

Directory Structure

SKILL.md

Report

Notice