diff --git a/docs/building-with-codegen/function-decorator.mdx b/docs/building-with-codegen/function-decorator.mdx new file mode 100644 index 000000000..ef38d958e --- /dev/null +++ b/docs/building-with-codegen/function-decorator.mdx @@ -0,0 +1,53 @@ +--- +title: Function Decorator +sidebarTitle: "@codegen.function" +icon: "at" +iconType: "solid" +--- + +# Function Decorator + +The `function` decorator is used to define codegen functions within your application. It allows you to specify a name for the function that will be ran making it easier to run specific codemods + +## Usage + +To use the `function` decorator, simply annotate your function with `@codegen.function` and provide a name as an argument. + +### Example + +```python +@codegen.function('my-function') +def run(codebase): + pass +``` + +In this example, the function `run` is decorated with `@codegen.function` and given the name `'my-function'`. This name will be used when the function is ran. + +## Parameters + +- `name` (str): The name of the function to be used when ran. + +## Description + +The `function` decorator is part of the codegen SDK CLI and is used to mark functions that are intended to be ran as part of a code generation process. It ensures that the function is properly registered and can be invoked with the specified name. + + +## CLI Examples + +### Running a Function + +To run a deployed function using the CLI, use the following command: + +```bash +codegen run my-function +``` + +This command runs the function named `my-function`. + +## See Also + +- [Webhook Decorator](./webhook-decorator.mdx): For handling webhook events with decorators. +- [Codebase Visualization](./codebase-visualization.mdx): For visualizing codebases in your application. +- [CLI Init Command](../cli/init.mdx): For initializing projects or environments related to the function decorator. +- [CLI Create Command](../cli/create.mdx): For creating new functions or projects using the CLI. +- [CLI Run Command](../cli/run.mdx): For running code or scripts using the CLI. diff --git a/docs/mint.json b/docs/mint.json index 8bed0b914..bc66b0d48 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -97,6 +97,7 @@ "building-with-codegen/parsing-codebases", "building-with-codegen/reusable-codemods", "building-with-codegen/dot-codegen", + "building-with-codegen/function-decorator", "building-with-codegen/language-support", "building-with-codegen/commit-and-reset", "building-with-codegen/git-operations",