Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/frontend/config/sidebar/reference.topics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -580,6 +580,10 @@ export const referenceTopics: StarlightSidebarTopicsUserConfig[number] = {
slug: 'reference/cli/commands/aspire-start',
},
{ label: 'aspire stop', slug: 'reference/cli/commands/aspire-stop' },
{
label: 'aspire template source add',
slug: 'reference/cli/commands/aspire-template-source-add',
},
{
label: 'aspire terminal',
collapsed: true,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: aspire template source add command
description: Learn about the aspire template source add command and its usage. This command adds a named template source to global configuration after confirming you trust it.
---

import Include from '@components/Include.astro';

## Name

`aspire template source add` - Add a named template source to global configuration after confirming you trust it.

## Synopsis

```bash title="Aspire CLI"
aspire template source add <name> [options]
Comment thread
davidfowl marked this conversation as resolved.
Resolved
```

## Description

The `aspire template source add` command adds a named template source to global Aspire configuration. A template source is either a Git repository (`--repository`, optionally with `--path` and `--ref`) or an absolute local directory (`--path` without `--repository`).
Comment thread
davidfowl marked this conversation as resolved.
Resolved
Comment thread
davidfowl marked this conversation as resolved.
Resolved

Templates can run code, so the command asks you to trust the source before it changes any configuration. After it validates the name and location, it writes the warning "Only use sources you trust. Content from these sources can run code on your machine." to standard error. Then it prompts for confirmation. The prompt shows the source name and its repository URL or local path, and defaults to **No**:

```text
Do you trust template source 'company' (https://example.com/templates)? [y/N]:
```

If you decline, the command is canceled and configuration isn't changed. To trust the source and skip the prompt, pass `--yes`.
Comment thread
davidfowl marked this conversation as resolved.
Resolved
Comment thread
davidfowl marked this conversation as resolved.
Resolved

Non-interactive invocations, including invocations where interactive input isn't available, fail unless you pass `--yes`.
Comment thread
davidfowl marked this conversation as resolved.
Resolved

## Arguments

The following arguments are available:

- **`name`**
Comment thread
davidfowl marked this conversation as resolved.
Resolved

The name of the template source. The name must be 1-64 ASCII letters, digits, dots (`.`), hyphens (`-`), or underscores (`_`), and must start with a letter or digit. Names are case-insensitive, and the command fails if a template source with the same name already exists.

## Options

The following options are available:

- **`--path`**

The template directory. Its meaning depends on whether `--repository` is specified:

- Without `--repository`, `--path` must be an absolute local directory that contains templates.
Comment thread
davidfowl marked this conversation as resolved.
Resolved
- With `--repository`, `--path` is a directory relative to the repository root. It can't be an absolute path or use `..` to point outside the repository. It defaults to the repository root (`.`).

- **`--repository`**

An HTTPS or SSH Git repository URL that contains templates.
Comment thread
davidfowl marked this conversation as resolved.
Resolved

- **`--ref`**

A Git branch, tag, or full commit SHA. Requires `--repository` and defaults to `HEAD`.
Comment thread
davidfowl marked this conversation as resolved.
Resolved

- **`-y, --yes`**
Comment thread
davidfowl marked this conversation as resolved.
Resolved

Trust the template source and skip confirmation.

- <Include relativePath="reference/cli/includes/option-help.md" />

- <Include relativePath="reference/cli/includes/option-log-level.md" />

- <Include relativePath="reference/cli/includes/option-non-interactive.md" />

- <Include relativePath="reference/cli/includes/option-nologo.md" />

- <Include relativePath="reference/cli/includes/option-banner.md" />

- <Include relativePath="reference/cli/includes/option-wait.md" />

## Examples

- Add a template source and confirm trust interactively:

```bash title="Aspire CLI"
aspire template source add company --repository https://example.com/templates
Comment thread
davidfowl marked this conversation as resolved.
Resolved
```

- Add a template source from a subdirectory of a repository at a specific tag:

```bash title="Aspire CLI"
aspire template source add company --repository https://example.com/templates --path templates/web --ref v1.0.0
Comment thread
davidfowl marked this conversation as resolved.
Resolved
```

- Add a template source from an absolute local directory:

```bash title="Aspire CLI"
aspire template source add local --path /home/user/templates
Comment thread
davidfowl marked this conversation as resolved.
Resolved
```

- Add a template source in automation by explicitly trusting it:

```bash title="Aspire CLI"
aspire template source add company --repository https://example.com/templates --non-interactive --yes
Comment thread
davidfowl marked this conversation as resolved.
Resolved
```
45 changes: 45 additions & 0 deletions src/frontend/tests/unit/cli-command-sidebar.vitest.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { readdirSync } from 'node:fs';
import { join } from 'node:path';

import { describe, expect, it } from 'vitest';

import { referenceTopics } from '../../config/sidebar/reference.topics';

const commandsDir = join(process.cwd(), 'src/content/docs/reference/cli/commands');

function collectSlugs(items: unknown, slugs: Set<string>): Set<string> {
if (!Array.isArray(items)) {
return slugs;
}

for (const item of items) {
if (typeof item === 'string') {
slugs.add(item);
} else if (item && typeof item === 'object') {
const { slug, items: children } = item as { slug?: unknown; items?: unknown };
if (typeof slug === 'string') {
slugs.add(slug);
}
collectSlugs(children, slugs);
}
}

return slugs;
}

describe('CLI command reference sidebar', () => {
it('lists every CLI command page so the page resolves to the Reference topic', () => {
const slugs = collectSlugs(referenceTopics.items, new Set());
const missing = readdirSync(commandsDir)
.filter((file) => /\.mdx?$/.test(file))
.map((file) => `reference/cli/commands/${file.replace(/\.mdx?$/, '')}`)
.filter((slug) => !slugs.has(slug));

expect(missing).toEqual([]);
});

it('includes the aspire template source add command', () => {
const slugs = collectSlugs(referenceTopics.items, new Set());
expect(slugs.has('reference/cli/commands/aspire-template-source-add')).toBe(true);
});
});
Loading