Parsing a Single File or Folder¶
Alchemist parses provided source path, which may be a mix of folders containing files or files themselves.
This command is mostly useful for migration specialist to review AST tree and debugging purposes.
Organize your project space
We recommend sitcking to the standard usage pattern. Read before proceeding.
Run using the following command:
alchemist -u -o out -p your_project_name parse path/to/src
It is also possible to generate sources & notification reports in parquet
or xlsx
format. For example for parquet format:
alchemist -u -o out -p your_project_name -f parquet parse path/to/src
To create a save
file, run alchemist save
command.
Troubleshooting¶
If you encounter issues, follow these tips:
Installation issues¶
If you can't install Alchemist, please contact us.
Invalid value for '-o' / '--output-path': Directory is not readable¶
In macOS Catalina and later versions, restricted folders include Documents
, Desktop
, Downloads
, among others. To solve this issue, you need to grant Terminal access to these folders through privacy settings.
Granting Terminal Access
Follow these steps to allow access to the folder:
- Open System Preferences on your Mac.
- Go to Security & Privacy.
- Select the Privacy tab.
- Scroll down to Files and Folders or Full Disk Access (depending on your macOS version).
- Look for the Terminal application (or the terminal you are using, such as iTerm) in the list.
-
Check the box next to it to grant access. If the application is not listed, you can add it by clicking the plus sign (+) and locating it in Finder.
-
Source skipped due to errors: Alchemist may report various errors during execution. Most of them will provide necessary information to resolve the issue, e.g. incorrect configuration or invalid input file. However, some source files may be skipped due to unexepected errors. If some files were skipped - most probably they were not supported by Alchemist, it will not impact the results for the remaining ones. Please, report this and we'll work on adding support for them.
App freezes¶
In rare cases, some source files may freeze the process. You may try to identify these and remove from sources and run operation again. If you can't identify the problematic files, please contact us.
Execution crashes or takes too much time¶
If you have hundreds or even thousands of files, you may run out of memory or the output may be too large. In this case, you can:
* Run in smaller chunks, i.e. running alchemist multiple times, each time providing a different set of input files or folders. Remember to use a different project name after the `-p` option on each run.
* Use a different output format, such as `-f parquet`.
Command not found¶
If typing alchemist
doesn't work (program not found), make sure you've finished our tutorial. Use the full path to the executable. For example, on Windows:
```
C:\Program Files (x86)\Alchemist\Alchemist\alchemist.exe -p project_name -f xlsx analyze path/to/a/file_or_folder
```
Remember to consult the built-in help (alchemist -h
or alchemist <command> -h
) for the most up-to-date information on using Alchemist CLI. For more information on analyzing and other operations, refer to the analyzing, parsing, and converting sections of the documentation.