Added more documentation in the cli
	
		
			
	
		
	
	
		
	
		
			All checks were successful
		
		
	
	
		
			
				
	
				ci/woodpecker/push/woodpecker Pipeline was successful
				
			
		
		
	
	
				
					
				
			
		
			All checks were successful
		
		
	
	ci/woodpecker/push/woodpecker Pipeline was successful
				
			This commit is contained in:
		
							parent
							
								
									83a4138f64
								
							
						
					
					
						commit
						02c6b50d00
					
				
							
								
								
									
										33
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										33
									
								
								README.md
									
									
									
									
									
								
							|  | @ -16,21 +16,36 @@ You can install dr the rust way with `cargo install dr` but downloading a binary | |||
| 
 | ||||
| ``` | ||||
| $ dr --help | ||||
| Command-line data file processing in Rust | ||||
| dr is a handy command line tool to handle csv and parquet files. | ||||
| It is designed to integrate nicely with other command line tools | ||||
| like cat, sed, awk and database clients cli. You can find more | ||||
| information an a short tutorial https://git.guillemborrell.es/guillem/dr | ||||
|              | ||||
| 
 | ||||
| Usage: dr [COMMAND] | ||||
| 
 | ||||
| Commands: | ||||
|   csv    Read csv, output arrow stream | ||||
|   sql    Runs a sql statement on the file | ||||
|   print  Pretty prints the table | ||||
|   rpq    Read parquet file | ||||
|   wpq    Write to a paquet file | ||||
|   help   Print this message or the help of the given subcommand(s) | ||||
|   csv | ||||
|           Read csv, output arrow stream | ||||
|   schema | ||||
|           Several table schema related utilities | ||||
|   sql | ||||
|           Runs a sql statement on the file | ||||
|   print | ||||
|           Pretty prints the table | ||||
|   rpq | ||||
|           Read parquet file | ||||
|   wpq | ||||
|           Write to a paquet file | ||||
|   help | ||||
|           Print this message or the help of the given subcommand(s) | ||||
| 
 | ||||
| Options: | ||||
|   -h, --help     Print help information | ||||
|   -V, --version  Print version information | ||||
|   -h, --help | ||||
|           Print help information (use `-h` for a summary) | ||||
| 
 | ||||
|   -V, --version | ||||
|           Print version information | ||||
| ``` | ||||
| 
 | ||||
| ## Howto | ||||
|  |  | |||
							
								
								
									
										10
									
								
								src/main.rs
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								src/main.rs
									
									
									
									
									
								
							|  | @ -8,6 +8,16 @@ use clap::command; | |||
| fn main() { | ||||
|     // Commands definition
 | ||||
|     let matches = command!() | ||||
|         .author("Guillem Borrell") | ||||
|         .version(env!("CARGO_PKG_VERSION")) | ||||
|         .about("dr is a handy command line tool to handle csv an parquet files") | ||||
|         .long_about( | ||||
|             "dr is a handy command line tool to handle csv and parquet files.
 | ||||
| It is designed to integrate nicely with other command line tools | ||||
| like cat, sed, awk and database clients cli. You can find more | ||||
| information an a short tutorial https://git.guillemborrell.es/guillem/dr
 | ||||
|             ",
 | ||||
|         ) | ||||
|         .subcommand(commands::gen_csv_command()) | ||||
|         .subcommand(commands::gen_schema_command()) | ||||
|         .subcommand(commands::gen_sql_command()) | ||||
|  |  | |||
		Loading…
	
		Reference in a new issue