astro Architecture Docs
Home / File/ create-key.ts — astro Source File

create-key.ts — astro Source File

Architecture documentation for create-key.ts, a typescript file in the astro codebase. 3 imports, 0 dependents.

File typescript CoreAstro RenderingEngine 3 imports 1 functions

Entity Profile

Dependency Diagram

graph LR
  ecd2472f_ebc7_019b_affb_7e0b159a6a4c["create-key.ts"]
  d3861967_b647_84d2_ff48_15013353bd56["../core/logger/core.js"]
  ecd2472f_ebc7_019b_affb_7e0b159a6a4c --> d3861967_b647_84d2_ff48_15013353bd56
  9eb8242b_fdf4_2f0a_cd20_f5365a0c228e["../domain/command.js"]
  ecd2472f_ebc7_019b_affb_7e0b159a6a4c --> 9eb8242b_fdf4_2f0a_cd20_f5365a0c228e
  ed048f50_11e0_eb52_7753_d6b333c4cfc9["../definitions.js"]
  ecd2472f_ebc7_019b_affb_7e0b159a6a4c --> ed048f50_11e0_eb52_7753_d6b333c4cfc9
  style ecd2472f_ebc7_019b_affb_7e0b159a6a4c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { Logger } from '../../../core/logger/core.js';
import { defineCommand } from '../../domain/command.js';
import type { KeyGenerator } from '../definitions.js';

interface Options {
	logger: Logger;
	keyGenerator: KeyGenerator;
}

export const createKeyCommand = defineCommand({
	help: {
		commandName: 'astro create-key',
		tables: {
			Flags: [['--help (-h)', 'See all available flags.']],
		},
		description: 'Generates a key to encrypt props passed to server islands.',
	},
	async run({ logger, keyGenerator }: Options) {
		const key = await keyGenerator.generate();

		logger.info(
			'crypto',
			`Generated a key to encrypt props passed to server islands. To reuse the same key across builds, set this value as ASTRO_KEY in an environment variable on your build server.\n\nASTRO_KEY=${key}`,
		);
	},
});

Domain

Subdomains

Functions

Types

Dependencies

  • ../core/logger/core.js
  • ../definitions.js
  • ../domain/command.js

Source

Frequently Asked Questions

What does create-key.ts do?
create-key.ts is a source file in the astro codebase, written in typescript. It belongs to the CoreAstro domain, RenderingEngine subdomain.
What functions are defined in create-key.ts?
create-key.ts defines 1 function(s): createKeyCommand.run.
What does create-key.ts depend on?
create-key.ts imports 3 module(s): ../core/logger/core.js, ../definitions.js, ../domain/command.js.
Where is create-key.ts in the architecture?
create-key.ts is located at packages/astro/src/cli/create-key/core/create-key.ts (domain: CoreAstro, subdomain: RenderingEngine, directory: packages/astro/src/cli/create-key/core).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free