# Welcome Welcome to Filestar, your ultimate solution for managing your files. Our powerful and versatile software is designed to meet all your file transformation needs with ease and efficiency. ### Getting Started Dive into our comprehensive guides and tutorials to make the most out of Filestar. Whether you're a beginner or an experienced user, our resources are tailored to help you streamline your workflow. # How to Update Filestar Filestar is automatically updated after a major release, but sometimes we make a minor patch. In these cases, you need to update manually. Start Filestar and click the *Check for Updates* option in the *Help* menu.

If there's a new version available you can now choose to update to this version.

### Update using the CLI If you're using the [CLI](/automation/filestar-cli) you can also use the *update* command to install the latest version of Filestar.

# Where is my files? A common misconception about Filestar is that you need to download the files after the conversion. Filestar will always process your files on your computer [except for a few exceptions](/other/privacy-and-security). \ \ By default, Filestar will save your files in the same directory as the original file. You can change this by setting the "Output Directory".

After the conversion has finished you can click on the output filename and access the file.

# Activate Filestar ### 1. Download the latest version of Filestar for Windows [Download Filestar](https://filestar.com/download) or [Update Filestar](/general/how-to-update-filestar). -> Then run the installer. ### 2. In the Help menu select *Plans*

-> Then click on *Restore Purchase.*

### 3. Enter your activation code

# Register This is how you register for our free plan. 1. Download and Install [Filestar](https://filestar.com/download). 2. Click *Help* then *Plans:*

3. Select the *Free* Plan:

# Cloud Credits We offer our subscribers unlimited access to most of our skills and conversions. That means you can use them as much as you need without any additional fees or limits. A select group of advanced skills are executed in our cloud and require significant computational resources. Because of this, we charge for these skills on a consumption basis and require the use of *cloud credits*. This allows us to ensure that we can continue to provide these high-quality services while also making them affordable for our customers. Every subscription comes with a set amount of cloud credits included. If you find that you need more credits to use our advanced AI skills, you can easily purchase more. [➡️ See all Filestar plans](https://filestar.com/pricing) [➡️ Read more about Cloud Credits](https://filestar.com/cloud-credits)

How can I purchase more cloud credits?

# Subscriptions

How can I manage my subscription?

In the Help menu, select "Billing". Here you can manage your subscription, see receipts and change payment method. ![](/files/HnnwulqqTVnnRPbB3d9Y)

# Recipes Recipes are a powerful feature in Filestar that allows you to chain several skills into a sequence. After creating a recipe you can connect the recipe to an automation like a [Trigger Folder](/automation/trigger-folders), [Desktop Shortcut](/automation/desktop-shortcuts) or a [Hotkey](/automation/hotkeys). You can also save and reuse recipes directly in the application. You can write an entire recipe using natural language in the search box and our AI will parse and match with the proper skills. ``` convert my file to BMP format then rotate the image 90 degrees to the left, zip the result and finally save it to my desktop ```

[See more examples below](#example-recipes) ### Modifying Recipes To manually create a multistep recipe click on the “Add Step” after selecting the first skill.

You can modify the recipe by right-clicking the step box on the left.

To insert a step in the middle of the recipe you hover the mouse over the arrow between two steps and click on the “+” icon.

On the result page, you can save your recipe or use it in an automation by clicking on the "Automate" button.

### Example Recipes ``` rotate 90 degrees, invert the image and then finally save in C:\Foo\Bar\ ``` ``` trim wav from 00:02:30 to 00:04:15, then reduce noise, and finally save as mp3 ``` ``` translate these documents into Dutch ``` ``` convert to something that I can open in Word ``` ``` overlay a watermark image in the centre, adjust the opacity to 30%, and save as JPEG ``` ``` clip the largest possible 2x4 ratio square in the middle of this video ``` ``` add red text in 20pt in the upper right corner with the width and height of the image ``` # Generate Skills with AI {% hint style="info" %} This feature currently only works for raster images, videos and audio files. {% endhint %} Filestar AI can generate code for completely new skills in real time. Here's an example: ``` insert the text “Filestar” 10 times in random locations and with random colours ```

This is a toy example of a skill that we don’t have. Our code-writing agent will automatically figure out that “Filestar” and “10” are parameters that you as a user might want to alter and write all the code for this skill in a few seconds and ship to the executed in a sandbox on your computer. ### Notes * AI generation is not deterministic and results can vary. If you're unhappy with the result, try running with the same prompt again.
# Bulk Renaming

Filestar has a powerful renaming system that allows you to control the filename for the produced files. In the following examples let's assume that we are converting the file `cat.jpg` to a PNG image. The following path template will give us the filename `cat.png`: ``` . ``` Anything between `<` and `>` is a special tag that is replaced with a value. Between the tags, you can have any characters to form your path and filenames. By specifying path templates you can create advanced renaming rules. Here's an example: ``` \--\. => "New York\1982-07-17\Photo.jpg" ``` ### Supported Tags #### Filename Is replaced with the name of the original file excluding the extension. #### Extension Is replaced with the new extension. #### Order Some skills return more than one file (like splitting a document into images). The tag is replaced with the numeric index of the output file counted from 0. Formatting can be controlled with the Format argument. ``` _. => "Document_001.jpg", "Document_002.jpg"... ``` #### Page Works the same way as the tag but the numeric index is counted from 1. #### Guid Is replaced with a new [Guid](https://en.wikipedia.org/wiki/Universally_unique_identifier). #### ArchivePath This tag is used when extracting files from an archive like a zip file to extract the files with the same folder structure as in the archive. #### Md5 Is replaced with the Md5 hash of the file. #### File Is replaced with a file property. ``` ``` #### Image Is replaced with image metadata. ``` ``` #### Mp3 Is replaced with mp3 metadata. ``` ``` #### Tag The tag is a special tag that can be used in combination with the "By Path" file selection method to submit a list of filenames through a CSV format. #### Case.Lower Method for lowercasing. ``` ``` #### Case.Upper Method for uppercasing. ``` ``` #### Trim Method for removing unwanted characters at the start or the end of a string. ``` ``` #### Substring Method for cutting out a piece of a string. ``` ``` #### Replace Method for replacing all occurrences of one string with another. ``` ``` # Load Files by URL Files can be loaded by submitting a URL.

# Load Files by Path Files can be add in a Filestar session by entering paths.

### Globs [Glob syntax](https://en.wikipedia.org/wiki/Glob_\(programming\)) is a way of specifying sets of filenames with wildcard characters. Here's a comprehensive explanation of different types of glob syntax: 1. **Asterisk (\*)**: Matches any number of characters (including none). For instance, `*.txt` matches any file with an `.txt` extension. 2. **Question Mark (?)**: Matches any single character. For example, `?.txt` would match `a.txt`, `b.txt`, but not `ab.txt`. 3. **Character Ranges \[ ]**: Matches any one of the enclosed characters. A range of characters can be specified with a dash. For example, `[a-c].txt` matches `a.txt`, `b.txt`, and `c.txt`. 4. **Negated Character Ranges \[! ]**: Matches any character not enclosed. For example, `[!a-c].txt` would match `d.txt` but not `a.txt`, `b.txt`, or `c.txt`. 5. **Curly Braces { }**: Matches any of the comma-separated patterns inside the braces. For example, `{file, test}.txt` matches `file.txt` and `test.txt`. 6. **Literal Match**: Any character not part of a special glob pattern (like `*`, `?`, `[ ]`, `{ }`) matches itself. 7. **Backslash Escaping**: A backslash can be used before a special character to treat it as a regular character. For example, `\\*` would match an actual asterisk `*`. 8. **Globstar**: Used to match directories and files within. For example, `**/*.txt` matches all `.txt` files in all directories and subdirectories. # Load Files by Drag\&Drop Files can be loaded by just dragging a file over the Filestar window. Either drop the file in the big *bucket* to choose among all of the skills or drop it into one of the suggested skill buckets at the bottom.

# Load Files by Copy\&Paste You can load files by copying a file from your computer and then pasting the file into Filestar using CTRL+V. This also works with text from a word processing application or a screenshot. # Exporters Exporters determine what happens with a file after it has been converted. By default, a file is *exported* to your local hard drive but we are a growing list of other exporters. Exporters can be used as a standalone skill as well. You need a paid [Filestar Subscription](https://filestar.com/pricing) to use exporters. {% hint style="info" %} Exporters are a new feature and we plan to add more in the coming months. 🙏 [Please help us prioritize by taking our exporter survey. ](https://airtable.com/app3chq6WRUMyVckS/shrabCipV859w0pB6) {% endhint %} Exporters are especially interesting in combination with automations such as [Trigger Folders](/automation/trigger-folders). ### Exporters * [Email](/advanced/exporters/email) * [HTTP Post](/advanced/exporters/http-post) # Email {% embed url="" %} The email exporter can attach your files in two different ways: * Attach as Files * Attach a Zipped Archive (with the option to encrypt the files with a password) There's a limit of 20 Mb for attachments as this is the limit of many email providers. Email is sent using Filestar Send service. As soon as the email has been sent we remove all files from our backend. {% hint style="info" %} This is a very new feature in Filestar and we have loads of ideas on how to improve it: * Sending through your own provider: Gmail, Outlook, Yahoo, SMTP or IMAP. * Sending larger files that are end-to-end encrypted with an option to deliver the password through SMS. **Please take our** [**Exporter Survey**](https://airtable.com/app3chq6WRUMyVckS/shrabCipV859w0pB6) **and let us know what you think.** {% endhint %} # HTTP Post

This exporter allows you to send your file as an HTTP Post request. This can be a useful way to integrate Filestar with your own custom services. # Trigger Folders {% hint style="info" %} Trigger Folders are currently only available on Windows. {% endhint %}

With trigger folders, you can run a recipe on any file that is dropped in a specified folder. For this to work, a small lightweight application called ‘FilestarAgent.exe’ needs to run on your computer. The agent monitors file changes in your trigger folders and initiate the conversions. When you create your first trigger folder, Filestar will make sure that this application is started when rebooting your computer. You can know that the agent is running if you can see the Filestar icon in your system tray. After you have run a skill you will see a button called ‘Automate’, clicking on this exposes a menu where one of the options is to create a new trigger folder. This will open the window seen in the image above. If you select ‘Run in Background’, Filestar will run the entire process in the background and only communicate through notifications. Files that Filestar produces and saves in a trigger folder does not trigger a conversion. # Desktop Shortcuts {% hint style="info" %} Desktop Shortcuts are currently only available on Windows. {% endhint %}

Many of you use Filestar for the same file conversions over and over. Maybe you convert daily Excel reports into pdf. Or work with images where you often need to change them from one file format into another. With the new feature Filestar Shortcuts, you can create your automated skill accessible right on your desktop. When you have finished one of those skills in Filestar that you know you want to use again, press the *Desktop Short* button. Choose the name and place for the shortcut, and you are done. Whenever you want to do that conversion again, just drag and drop your files onto the shortcut icon on the desktop - and the skill will be started and done automatically. Check out the animation below to see how smooth it is. # Command Line Scripts If you want to use Filestar in your own command line scripts you can generate the arguments for the [Filestar CLI](/automation/filestar-cli) on the results page.

# Command Line Aliases {% hint style="info" %} Command Line Aliases are currently only available on Windows. {% endhint %}

Let's say that you have a skill with a set of parameters that want to reuse through the CLI, for example, you might want to add a specific text in the top left corner of an image. After running a skill you can save this *recipe* as a *Command Line Alias*. You find the tool to create such aliases in the *Automate* menu. After creating an alias, the name specified is then available as a command on your terminal with the same arguments as the [CLI](/automation/filestar-cli). # Hotkeys {% hint style="info" %} Hotkeys are currently only available on Windows. {% endhint %}

With the *Hotkeys* automation feature, you can execute recipes on selected files when pressing a specified hotkey. For this to work, a small lightweight application called *FilestarAgent.exe* needs to run on your computer. The agent monitors file changes in your trigger folders and initiates the conversions. When you create your hotkey, Filestar will make sure that this application is started when rebooting your computer. You can know that the agent is running if you can see the Filestar icon in your system tray. After you have run a skill you will see a button called *Automate*, clicking on this exposes a menu where one of the options is to create a new hotkey. This will open the window seen in the image above. If you select *Run in Background*, Filestar will run the entire process in the background and only communicate through notifications. # Filestar CLI {% hint style="info" %} Filestar CLI is currently only available on Windows. {% endhint %}

### Examples Convert cat.jpg in the current folder to cat.png and store it in the folder c:\workspace: ``` >filestarcli -i cat.jpg -c "convert to png" -o C:\workspace ``` Merge page1.pdf and page2.pdf in the current folder: ``` >filestarcli -i page1.pdf page2.pdf -c "merge" ``` ### Arguments ``` -i --input ``` Specify paths as absolute or relative to current directories. It can contain a combination of valid literal path and wildcard (\* and ?) characters, but it doesn't support regular expressions. ``` -o --output -o . -o foo.gif -o "c:\foo bar\" -o c:\foo\bar. ``` Specifies how to handle the output. If omitted each file will be saved in its respective source directory. ``` -r --recursive ``` Recursively find files in sub-directories in the current directory. ``` -c --command ``` Command, i.e. "convert to jpg" ``` -p --parameters ``` Skill parameters. ``` --output-template ``` Specifies how to name the converted files. If omitted, this template is used: \.\ ``` --loglevel ``` Available options: * Normal (default) * Quiet * Verbose ``` --recipe ``` Path to a stored recipe file. ``` --cloud ``` Specify how to handle cloud skills. Available options: * Disallowed (default) * Allowed * Forced ``` --output-conflict ``` Strategy to use if there are conflicting filenames when saving files. Available options: * AppendNumber (default) * Replace * Skip * Warn ``` --version ``` Show version information ``` -?, -h, --help ``` Show help and usage information. ### Commands ``` >filestarcli register ``` Register Filestar on the current machine with the specified activation code. ``` >filestarcli update ``` Update Filestar on the current machine to the latest version. # macOS ###

Submit a macOS installer log for troubleshooting

First, make sure you get the latest version from https//filestar.com/download. Then run the installer. Make sure you enter your admin password correctly. On the screen where it says "Installation Failed", click "Installer Log" in the "Window" menu. Use the dropdown to "Show All Logs". Press save to save the log to the disc and send it back to us for troubleshooting.

I accidentally clicked on deny access during installation

You can modify the permissions in your system settings to allow access to Filestar that you previously denied on your Mac. Here's how you can do it: 1. **Open System Preferences**: Click on the Apple menu at the top left corner of your screen and select "System Preferences". 2. **Go to Security & Privacy**: Find and click on the "Security & Privacy" icon. 3. **Unlock to Make Changes**: Click the lock icon at the bottom left of the window to make changes. You will need to enter your administrator password. 4. **Access Privacy Tab**: Click on the "Privacy" tab at the top of the window. 5. **Modify Permissions**: In the Privacy tab, you will see a list of categories on the left. Select Full Disk Access. 6. **Find Filestar**: In the right pane, find the application you want to grant access to and check the box next to it. If the application is not listed, you may need to add it by clicking the "+" button under the list. 7. **Lock to Prevent Further Changes**: After making the changes, click the lock icon again to prevent further changes. 8. **Restart the System**: Restart the system to ensure the changes take effect.

# Privacy and Security When using Filestar your files are processed directly on your machine. In some rare cases, we use our own or third-party services (mostly for AI services) to process the file. In these cases, you will see a cloud icon in the user interface and we will explicitly ask permission to send your files to the cloud before starting the job.

The following data is sent from the client to our services when using Filestar: * Our search engine is hosted in our cloud, as well as our AI recipe builder and blueprint engine. These together will produce the "blueprint" for your request. The blueprint instructs the client to download plugins that need to be updated or installed. Only metadata such as filetype are sent to these services. * We collect some usage data to improve our services and user interface. This data is stored anonymously in Microsoft Azure Application Insights. * All errors that occur in the Filestar client are sent to [Exceptionless](https://exceptionless.com/). * Our separate license service is used to validate subscriptions and manage user information.