newroco
/
searchanddisplace-core
9
0
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity
Repo for the search and displace core module including the interface to select files and search and displace operations to run on them. https://searchanddisplace.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
29 Commits
1 Branch
0 Tags
16 MiB
 
 
 
 
 
 
Tree: d962a908cd
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd962a908cd'
${ noResults }
searchanddisplace-core/demo-cli/README.md

1.7 KiB
Raw Blame History

Running S&D via CLI

Command

php artisan sd:run {path} {searchers*}

The command accepts two arguments:

  • path: The path to the document file on which the Search&Displace will run
  • searchers: This argument can be one of the following two types:
    • file searchers: the argument must only have one group in the format 'path:replace_with', where path is the path to a valid JSON file
    • inline searchers: the argument can have multiple groups of inline searchers in the format 'key: replace_with'. The 'key' represents a valid searcher found in the 'storage/app/searchers' directory, without the '.json' extension.

The 'replace_with' value is optional, not using it will remove the found text strings.

The resulted Markdown document will be created in the same directory as the input document file.

Examples

Note! These examples work when running the command from the root app directory, otherwise you have to input the correct paths in the command, including for the 'artisan' file.

  • Using valid JSON file searcher and removing all strings found php artisan sd:run ./demo-cli/demo_document.pdf ./demo-cli/demo_searcher.json

  • Using valid JSON file searcher and replacing all strings found with the string 'EMAIL' php artisan sd:run ./demo-cli/demo_document.pdf ./demo-cli/demo_searcher.json:EMAIL

  • Using valid searcher key (which exists in the directory 'storage/app/searchers') and removing all strings found php artisan sd:run ./demo-cli/demo_document.pdf demo_searcher:EMAIL

  • Using valid searcher key (which exists in the directory 'storage/app/searchers') and replacing all strings found with the string 'EMAIL' php artisan sd:run ./demo-cli/demo_document.pdf demo_searcher:EMAIL