Where is the documentation that describes the various forge cli template choices? Same for the category choices? How should I know which to select when I do “forge cli”?
1 Like
I’m also trying to figure this out.
The best I can find is:
https://developer.atlassian.com/platform/forge/ui-kit-components/issue-glance/
Definitely feels like we need to call out the different types somewhere.
Would it make sense to add it at the bottom of https://developer.atlassian.com/platform/forge/getting-started/ before the Next Steps?
Maybe a header section like, Choosing the right template or something along those lines?
5 Likes
Hi, I’m curious if this documentation has been published as I am also looking to get more insights on the list of forge templates and their descriptions. 
1 Like
Hmm, unfortunately, it seems there is still no documentation on this.
For anyone interested in browsing the available templates directly, they are located here: Log in with Atlassian account
Still waiting on this. When we click forge create, then we click show all. This brings a dropdown of templates. We would like to be able to view that list on the documentation.
I think this is what you’re looking for (as of Nov 2024). They just don’t explicitly specify which module relates to what template but I think there’s enough information to go on to at least start in the right direction.
Which choice should you make?
After ‘forge create’ you’ll be prompted to name your app. Be sure to check the approval guidelines in case you would like to share your app (as a free or paid app).
App approval guidelines
First options after naming your app are:
- Rovo Agent and Action: For automated actions and bots.
- UI Kit: React-based framework that allows you to enhance Atlassian products on Forge.
- Custom UI: allows you full control in building the app’s user interface. Custom UI runs within an iframe, providing an isolated environment for the app’s interface to be displayed.
- Triggers and Validators: For backend processes, validations, or triggers without visual components.
When you select ‘Show All’:
You will be able to choose between templates listed here.
First of all it’s good to know the following UI options:
- UI Kit (csuik): Use the standardized and lightweight Forge UI Kit.
- Custom UI: Develop a fully customized user interface (use of frame for HTML & JavaScript).
- TypeScript UI Kit: Work with TypeScript and the UI Kit for better type-checking.
Here’s a description of the templates:
1. General templates
- blank: A barebones template without any predefined modules or configurations. Use this to build an app entirely from scratch.
- scheduled-trigger: Execute tasks at scheduled intervals, such as daily updates or automated reports.
- webtrigger: Define an external API endpoint that other systems can call, enabling integration with external applications.
- product-trigger: React to product-level events across Atlassian applications, such as issue creation or updates.
- action-rovo: Automate processes across Atlassian products using the Rovo framework.
- rovo-agent-rovo: Implement a Rovo agent to handle tasks such as advanced workflows or notifications.
2. Jira-specific templates
For integrations within Jira:
Admin-Level Features
- jira-admin-page: Create custom admin pages in Jira to manage global or project-specific configurations. These pages are typically accessible to Jira administrators and can be used for settings, reports, or additional tools.
Issue-level features
- jira-issue-panel: Add a custom panel to Jira issue pages to show additional details or actions.
- jira-issue-glance: Create a glance view for compact issue data visualization.
- jira-issue-action: Add actionable buttons to Jira issue pages for quick operations.
- jira-issue-activity: Display custom activity in the issue activity stream.
Field-level features
- jira-custom-field: Add custom fields to Jira issues for specialized data.
- jira-custom-field-type: Define new types of custom fields with specific behaviors.
Dashboard and global features
- jira-dashboard-gadget: Build widgets for Jira dashboards to show summaries or stats.
- jira-global-page: Add custom global pages accessible from Jira’s main menu.
- jira-global-permission: Define permissions for specific user roles globally.
Workflow features
- jira-workflow-validator: Create validations that must be met before transitioning a workflow step.
- jira-workflow-condition: Define conditions for workflows to enforce specific rules.
- jira-workflow-postfunction: Automate actions when workflow transitions occur.
Jira Service Management
- jira-service-management-portal-header/footer: Customize the header or footer of the customer portal.
- jira-service-management-portal-request-detail: Extend the request details view with additional panels or actions.
- jira-service-management-organization-panel: Add features to organization management within Jira Service Management.
3. Confluence-specific templates
For integrations within Confluence:
Content interaction
- confluence-content-action: Add actions within Confluence content, such as buttons or interactive elements.
- confluence-content-byline: Add custom information or links to the byline section of Confluence pages.
- confluence-context-menu: Extend the right-click context menu with additional functionality.
Macros
- confluence-macro: Create reusable macros for embedding dynamic content within pages.
- confluence-macro-with-custom-configuration: Build macros that allow users to configure their behavior.
Global features
- confluence-global-page: Create global pages accessible from the Confluence menu.
- confluence-global-settings: Add custom global settings for Confluence administrators.
- confluence-homepage-feed: Add personalized or global feeds to the Confluence homepage.
Space-level features
- confluence-space-page: Add pages that are specific to Confluence spaces.
- confluence-space-settings: Extend the settings menu within spaces.
4. Bitbucket-specific templates
For integrations within Bitbucket:
Pull requests
- bitbucket-pull-request-action: Add actions within the pull request UI, such as buttons for automation.
- bitbucket-pull-request-card: Display custom cards inside pull requests to show additional information or insights.
- bitbucket-pull-request-overview-panel: Create an overview panel within pull requests for analytics or code insights.
Repository-level features
- bitbucket-repository-code-overview-action: Provide actions within the repository’s code overview.
- bitbucket-repository-code-overview-card: Add informational cards to the repository’s code overview.
- bitbucket-repository-main-menu-page: Build custom pages within the main menu of a Bitbucket repository.
- bitbucket-repository-settings-menu-page: Extend the settings menu for a repository with custom options.
Workspace-level features
- bitbucket-workspace-settings-menu-page: Add custom pages or settings at the workspace level.
Pipelines and merge checks
- bitbucket-dynamic-pipelines-provider: Automate pipeline creation and execution dynamically.
- bitbucket-merge-check: Implement conditions to ensure that pull requests meet specific criteria before merging.
5. Compass-specific templates
For integrations within Atlassian Compass:
- compass-admin-page: Add admin pages within Compass to manage resources or configurations.
- compass-component-page: Extend the component pages with additional panels or actions.
- compass-global-page: Build global pages for analytics or global settings.
- compass-team-page: Add custom pages specific to team settings or resources.
- compass-data-provider: Supply data dynamically for Compass modules.
Happy coding!
2 Likes