SiYuan icon

SiYuan

Manage SiYuan notebooks, documents, blocks, attributes, and more. Designed for AI agent workflows.

Asset → Rename File

AI-generated

Overview

This node operation renames a file within the SiYuan workspace. It is useful for managing file organization by changing the file path or name without altering the file content. For example, you can rename a file from an old directory path to a new directory path to keep your workspace tidy or to reflect updated naming conventions.

Use Case Examples

  1. Renaming a file from '/old-folder/old-file.txt' to '/new-folder/new-file.txt' in the SiYuan workspace.
  2. Organizing files by moving them to different folders through renaming their paths.

Properties

Name Meaning
Current Path The current path of the file to rename, specifying which file will be renamed.
New Path The new path for the file, specifying the target name and location after renaming.

Output

JSON

  • success - Indicates whether the rename operation was successful.

Dependencies

  • Requires SiYuan API URL and API token credentials for authentication.

Troubleshooting

  • Ensure that the API URL and token credentials are correctly set; missing or incorrect credentials will cause authentication errors.
  • Verify that the current file path exists in the SiYuan workspace; attempting to rename a non-existent file will result in an error.
  • Check that the new file path is valid and does not conflict with existing files to avoid rename failures.

Discussion